stream

package module

Go to main page

Versions in this module

v4

v4.3.2

Mar 27, 2020

Changes in this version

type ClientInterface

+ GetEnrichedActivitiesByForeignID func(values ...ForeignIDTimePair) (*GetEnrichedActivitiesResponse, error)

+ GetEnrichedActivitiesByID func(ids ...string) (*GetEnrichedActivitiesResponse, error)

v4.3.1

Mar 27, 2020

v4.3.0

Mar 17, 2020

Changes in this version

+ var CreateCollectionReference = (&CollectionsClient{}).CreateReference

+ var CreateUserReference = (&UsersClient{}).CreateReference

v4.2.0

Mar 17, 2020

Changes in this version

type Client

+ func (c *Client) GetEnrichedActivitiesByForeignID(values ...ForeignIDTimePair) (*GetEnrichedActivitiesResponse, error)

+ func (c *Client) GetEnrichedActivitiesByID(ids ...string) (*GetEnrichedActivitiesResponse, error)

+ type GetEnrichedActivitiesResponse struct

+ Results []EnrichedActivity

v4.1.1

Feb 26, 2020

v4.1.0

Feb 26, 2020

v4.0.1

Feb 14, 2020

v4.0.0

Jan 16, 2020

Changes in this version

+ const ReactionTimeLayout

+ const TimeLayout

+ var ErrInvalidNextPage = fmt.Errorf("invalid format for Next field")

+ var ErrMissingNextPage = fmt.Errorf("request missing next page")

+ var Version = "v4.0.0"

+ type APIError struct

+ Code int

+ Detail string

+ Duration Duration

+ Exception string

+ ExceptionFields map[string][]interface{}

+ StatusCode int

+ func ToAPIError(err error) (APIError, bool)

+ func (e APIError) Error() string

+ type Activity struct

+ Actor string

+ Extra map[string]interface{}

+ ForeignID string

+ ID string

+ Object string

+ Origin string

+ Score float64

+ Target string

+ Time Time

+ To []string

+ Verb string

+ func (a *Activity) UnmarshalJSON(b []byte) error

+ func (a Activity) MarshalJSON() ([]byte, error)

+ type ActivityGroup struct

+ Activities []Activity

+ type AddActivitiesResponse struct

+ Activities []Activity

+ type AddActivityResponse struct

+ type AddObjectOption func(*addCollectionRequest)

+ func WithUserID(userID string) AddObjectOption

+ type AddReactionRequestObject struct

+ ActivityID string

+ Data map[string]interface{}

+ ID string

+ Kind string

+ ParentID string

+ TargetFeeds []string

+ UserID string

+ type AddToManyRequest struct

+ Activity Activity

+ FeedIDs []string

+ type AggregatedFeed struct

+ func (f *AggregatedFeed) AddActivities(activities ...Activity) (*AddActivitiesResponse, error)

+ func (f *AggregatedFeed) AddActivity(activity Activity) (*AddActivityResponse, error)

+ func (f *AggregatedFeed) Follow(feed *FlatFeed, opts ...FollowFeedOption) error

+ func (f *AggregatedFeed) GetActivities(opts ...GetActivitiesOption) (*AggregatedFeedResponse, error)

+ func (f *AggregatedFeed) GetEnrichedActivities(opts ...GetActivitiesOption) (*EnrichedAggregatedFeedResponse, error)

+ func (f *AggregatedFeed) GetFollowing(opts ...FollowingOption) (*FollowingResponse, error)

+ func (f *AggregatedFeed) GetNextPageActivities(resp *AggregatedFeedResponse) (*AggregatedFeedResponse, error)

+ func (f *AggregatedFeed) GetNextPageEnrichedActivities(resp *EnrichedAggregatedFeedResponse) (*EnrichedAggregatedFeedResponse, error)

+ func (f *AggregatedFeed) ID() string

+ func (f *AggregatedFeed) RealtimeToken(readonly bool) string

+ func (f *AggregatedFeed) RemoveActivityByForeignID(foreignID string) error

+ func (f *AggregatedFeed) RemoveActivityByID(id string) error

+ func (f *AggregatedFeed) Slug() string

+ func (f *AggregatedFeed) Unfollow(target Feed, opts ...UnfollowOption) error

+ func (f *AggregatedFeed) UpdateToTargets(activity Activity, opts ...UpdateToTargetsOption) error

+ func (f *AggregatedFeed) UserID() string

+ type AggregatedFeedResponse struct

+ Results []ActivityGroup

+ type AnalyticsClient struct

+ func (c *AnalyticsClient) RedirectAndTrack(url string, events ...map[string]interface{}) (string, error)

+ func (c *AnalyticsClient) TrackEngagement(events ...EngagementEvent) error

+ func (c *AnalyticsClient) TrackImpression(eventsData ImpressionEventsData) error

+ type Client struct

+ func NewClient(key, secret string, opts ...ClientOption) (*Client, error)

+ func NewClientFromEnv() (*Client, error)

+ func (c *Client) AddToMany(activity Activity, feeds ...Feed) error

+ func (c *Client) AggregatedFeed(slug, userID string) (*AggregatedFeed, error)

+ func (c *Client) Analytics() *AnalyticsClient

+ func (c *Client) Collections() *CollectionsClient

+ func (c *Client) FlatFeed(slug, userID string) (*FlatFeed, error)

+ func (c *Client) FollowMany(relationships []FollowRelationship, opts ...FollowManyOption) error

+ func (c *Client) GetActivitiesByForeignID(values ...ForeignIDTimePair) (*GetActivitiesResponse, error)

+ func (c *Client) GetActivitiesByID(ids ...string) (*GetActivitiesResponse, error)

+ func (c *Client) GetUserSessionToken(userID string) (string, error)

+ func (c *Client) GetUserSessionTokenWithClaims(userID string, claims map[string]interface{}) (string, error)

+ func (c *Client) NotificationFeed(slug, userID string) (*NotificationFeed, error)

+ func (c *Client) PartialUpdateActivities(changesets ...UpdateActivityRequest) (*UpdateActivitiesResponse, error)

+ func (c *Client) Personalization() *PersonalizationClient

+ func (c *Client) Reactions() *ReactionsClient

+ func (c *Client) UnfollowMany(relationships []UnfollowRelationship) error

+ func (c *Client) UpdateActivities(activities ...Activity) error

+ func (c *Client) UpdateActivityByForeignID(foreignID string, timestamp Time, set map[string]interface{}, unset []string) (*UpdateActivityResponse, error)

+ func (c *Client) UpdateActivityByID(id string, set map[string]interface{}, unset []string) (*UpdateActivityResponse, error)

+ func (c *Client) Users() *UsersClient

+ type ClientInterface interface

+ AddToMany func(activity Activity, feeds ...Feed) error

+ AggregatedFeed func(slug, userID string) (*AggregatedFeed, error)

+ Analytics func() *AnalyticsClient

+ Collections func() *CollectionsClient

+ FlatFeed func(slug, userID string) (*FlatFeed, error)

+ FollowMany func(relationships []FollowRelationship, opts ...FollowManyOption) error

+ GetActivitiesByForeignID func(values ...ForeignIDTimePair) (*GetActivitiesResponse, error)

+ GetActivitiesByID func(ids ...string) (*GetActivitiesResponse, error)

+ GetUserSessionToken func(userID string) (string, error)

+ GetUserSessionTokenWithClaims func(userID string, claims map[string]interface{}) (string, error)

+ NotificationFeed func(slug, userID string) (*NotificationFeed, error)

+ PartialUpdateActivities func(changesets ...UpdateActivityRequest) (*UpdateActivitiesResponse, error)

+ Personalization func() *PersonalizationClient

+ Reactions func() *ReactionsClient

+ UnfollowMany func(relationships []UnfollowRelationship) error

+ UpdateActivities func(activities ...Activity) error

+ UpdateActivityByForeignID func(foreignID string, timestamp Time, set map[string]interface{}, unset []string) (*UpdateActivityResponse, error)

+ UpdateActivityByID func(id string, set map[string]interface{}, unset []string) (*UpdateActivityResponse, error)

+ Users func() *UsersClient

+ type ClientOption func(*Client)

+ func WithAPIRegion(region string) ClientOption

+ func WithAPIVersion(version string) ClientOption

+ func WithHTTPRequester(requester Requester) ClientOption

+ type CollectionObject struct

+ Data map[string]interface{}

+ ID string

+ func (o CollectionObject) MarshalJSON() ([]byte, error)

+ type CollectionsClient struct

+ func (c *CollectionsClient) Add(collection string, object CollectionObject, opts ...AddObjectOption) (*CollectionObject, error)

+ func (c *CollectionsClient) CreateReference(collection, id string) string

+ func (c *CollectionsClient) Delete(collection, id string) error

+ func (c *CollectionsClient) DeleteMany(collection string, ids ...string) error

+ func (c *CollectionsClient) Get(collection, id string) (*CollectionObject, error)

+ func (c *CollectionsClient) Select(collection string, ids ...string) ([]GetCollectionResponseObject, error)

+ func (c *CollectionsClient) Update(collection, id string, data map[string]interface{}) (*CollectionObject, error)

+ func (c *CollectionsClient) Upsert(collection string, objects ...CollectionObject) error

+ type Data struct

+ Extra map[string]interface{}

+ ID string

+ type Duration struct

+ func (d *Duration) UnmarshalJSON(b []byte) error

+ func (d Duration) MarshalJSON() ([]byte, error)

+ type EngagementEvent map[string]interface

+ func (e EngagementEvent) WithBoost(boost int) EngagementEvent

+ func (e EngagementEvent) WithContent(foreignID string, content map[string]interface{}) EngagementEvent

+ func (e EngagementEvent) WithFeatures(features ...EventFeature) EngagementEvent

+ func (e EngagementEvent) WithFeedID(feedID string) EngagementEvent

+ func (e EngagementEvent) WithForeignID(foreignID string) EngagementEvent

+ func (e EngagementEvent) WithLabel(label string) EngagementEvent

+ func (e EngagementEvent) WithLocation(location string) EngagementEvent

+ func (e EngagementEvent) WithPosition(position int) EngagementEvent

+ func (e EngagementEvent) WithTrackedAt(trackedAt time.Time) EngagementEvent

+ func (e EngagementEvent) WithUserData(userData *UserData) EngagementEvent

+ type EnrichedActivity struct

+ Actor Data

+ Extra map[string]interface{}

+ ForeignID string

+ ID string

+ LatestReactions map[string][]*EnrichedReaction

+ Object Data

+ Origin Data

+ OwnReactions map[string][]*EnrichedReaction

+ ReactionCounts map[string]int

+ Score float64

+ Target Data

+ Time Time

+ To []string

+ Verb string

+ func (a *EnrichedActivity) UnmarshalJSON(b []byte) error

+ func (a EnrichedActivity) MarshalJSON() ([]byte, error)

+ type EnrichedActivityGroup struct

+ Activities []EnrichedActivity

+ type EnrichedAggregatedFeedResponse struct

+ Results []EnrichedActivityGroup

+ type EnrichedFlatFeedResponse struct

+ Results []EnrichedActivity

+ type EnrichedNotificationFeedResponse struct

+ Results []EnrichedNotificationFeedResult

+ type EnrichedNotificationFeedResult struct

+ Activities []EnrichedActivity

+ type EnrichedReaction struct

+ ActivityID string

+ ChildrenCounters map[string]int

+ ChildrenReactions map[string][]*EnrichedReaction

+ CreatedAt Time

+ Data map[string]interface{}

+ ID string

+ Kind string

+ OwnChildren map[string][]*EnrichedReaction

+ ParentID string

+ TargetFeeds []string

+ UpdatedAt Time

+ User Data

+ UserID string

+ type EventFeature struct

+ Group string

+ Value string

+ func NewEventFeature(group, value string) EventFeature

+ type Feed interface

+ AddActivities func(...Activity) (*AddActivitiesResponse, error)

+ AddActivity func(Activity) (*AddActivityResponse, error)

+ Follow func(*FlatFeed, ...FollowFeedOption) error

+ GetFollowing func(...FollowingOption) (*FollowingResponse, error)

+ ID func() string

+ RealtimeToken func(bool) string

+ RemoveActivityByForeignID func(string) error

+ RemoveActivityByID func(string) error

+ Slug func() string

+ Unfollow func(Feed, ...UnfollowOption) error

+ UpdateToTargets func(Activity, ...UpdateToTargetsOption) error

+ UserID func() string

+ type FilterReactionResponse struct

+ Activity map[string]interface{}

+ Results []Reaction

+ type FilterReactionsAttribute func() string

+ func ByActivityID(activityID string) FilterReactionsAttribute

+ func ByReactionID(reactionID string) FilterReactionsAttribute

+ func ByUserID(userID string) FilterReactionsAttribute

+ func (a FilterReactionsAttribute) ByKind(kind string) FilterReactionsAttribute

+ type FilterReactionsOption struct

+ func WithActivityData() FilterReactionsOption

+ func WithIDGT(id string) FilterReactionsOption

+ func WithIDGTE(id string) FilterReactionsOption

+ func WithIDLT(id string) FilterReactionsOption

+ func WithIDLTE(id string) FilterReactionsOption

+ func WithLimit(limit int) FilterReactionsOption

+ func WithOwnChildren() FilterReactionsOption

+ type FlatFeed struct

+ func (f *FlatFeed) AddActivities(activities ...Activity) (*AddActivitiesResponse, error)

+ func (f *FlatFeed) AddActivity(activity Activity) (*AddActivityResponse, error)

+ func (f *FlatFeed) Follow(feed *FlatFeed, opts ...FollowFeedOption) error

+ func (f *FlatFeed) GetActivities(opts ...GetActivitiesOption) (*FlatFeedResponse, error)

+ func (f *FlatFeed) GetActivitiesWithRanking(ranking string, opts ...GetActivitiesOption) (*FlatFeedResponse, error)

+ func (f *FlatFeed) GetEnrichedActivities(opts ...GetActivitiesOption) (*EnrichedFlatFeedResponse, error)

+ func (f *FlatFeed) GetEnrichedActivitiesWithRanking(ranking string, opts ...GetActivitiesOption) (*EnrichedFlatFeedResponse, error)

+ func (f *FlatFeed) GetFollowers(opts ...FollowersOption) (*FollowersResponse, error)

+ func (f *FlatFeed) GetFollowing(opts ...FollowingOption) (*FollowingResponse, error)

+ func (f *FlatFeed) GetNextPageActivities(resp *FlatFeedResponse) (*FlatFeedResponse, error)

+ func (f *FlatFeed) GetNextPageEnrichedActivities(resp *EnrichedFlatFeedResponse) (*EnrichedFlatFeedResponse, error)

+ func (f *FlatFeed) ID() string

+ func (f *FlatFeed) RealtimeToken(readonly bool) string

+ func (f *FlatFeed) RemoveActivityByForeignID(foreignID string) error

+ func (f *FlatFeed) RemoveActivityByID(id string) error

+ func (f *FlatFeed) Slug() string

+ func (f *FlatFeed) Unfollow(target Feed, opts ...UnfollowOption) error

+ func (f *FlatFeed) UpdateToTargets(activity Activity, opts ...UpdateToTargetsOption) error

+ func (f *FlatFeed) UserID() string

+ type FlatFeedResponse struct

+ Results []Activity

+ type FollowFeedOption func(*followFeedOptions)

+ func WithFollowFeedActivityCopyLimit(activityCopyLimit int) FollowFeedOption

+ type FollowManyOption struct

+ func WithFollowManyActivityCopyLimit(activityCopyLimit int) FollowManyOption

+ type FollowRelationship struct

+ ActivityCopyLimit *int

+ Source string

+ Target string

+ func NewFollowRelationship(source, target Feed, opts ...FollowRelationshipOption) FollowRelationship

+ type FollowRelationshipOption func(r *FollowRelationship)

+ func WithFollowRelationshipActivityCopyLimit(activityCopyLimit int) FollowRelationshipOption

+ type Follower struct

+ FeedID string

+ TargetID string

+ type FollowersOption struct

+ func WithFollowersLimit(limit int) FollowersOption

+ func WithFollowersOffset(offset int) FollowersOption

+ type FollowersResponse struct

+ type FollowingOption struct

+ func WithFollowingFilter(ids ...string) FollowingOption

+ func WithFollowingLimit(limit int) FollowingOption

+ func WithFollowingOffset(offset int) FollowingOption

+ type FollowingResponse struct

+ type ForeignIDTimePair struct

+ ForeignID string

+ Timestamp Time

+ func NewForeignIDTimePair(foreignID string, timestamp Time) ForeignIDTimePair

+ type GetActivitiesOption struct

+ func WithActivitiesIDGT(id string) GetActivitiesOption

+ func WithActivitiesIDGTE(id string) GetActivitiesOption

+ func WithActivitiesIDLT(id string) GetActivitiesOption

+ func WithActivitiesIDLTE(id string) GetActivitiesOption

+ func WithActivitiesLimit(limit int) GetActivitiesOption

+ func WithActivitiesOffset(offset int) GetActivitiesOption

+ func WithCustomParam(name, value string) GetActivitiesOption

+ func WithEnrichOwnChildren() GetActivitiesOption

+ func WithEnrichOwnReactions() GetActivitiesOption

+ func WithEnrichReactionCounts() GetActivitiesOption

+ func WithEnrichReactionKindsFilter(kinds ...string) GetActivitiesOption

+ func WithEnrichRecentReactions() GetActivitiesOption

+ func WithEnrichRecentReactionsLimit(limit int) GetActivitiesOption

+ func WithNotificationsMarkRead(all bool, activityIDs ...string) GetActivitiesOption

+ func WithNotificationsMarkSeen(all bool, activityIDs ...string) GetActivitiesOption

+ type GetActivitiesResponse struct

+ Results []Activity

+ type GetCollectionResponseObject struct

+ Data map[string]interface{}

+ ForeignID string

+ type ImpressionEventsData map[string]interface

+ func (d ImpressionEventsData) AddForeignIDs(foreignIDs ...string) ImpressionEventsData

+ func (d ImpressionEventsData) WithFeatures(features ...EventFeature) ImpressionEventsData

+ func (d ImpressionEventsData) WithFeedID(feedID string) ImpressionEventsData

+ func (d ImpressionEventsData) WithForeignIDs(foreignIDs ...string) ImpressionEventsData

+ func (d ImpressionEventsData) WithLocation(location string) ImpressionEventsData

+ func (d ImpressionEventsData) WithPosition(position int) ImpressionEventsData

+ func (d ImpressionEventsData) WithTrackedAt(trackedAt time.Time) ImpressionEventsData

+ func (d ImpressionEventsData) WithUserData(userData *UserData) ImpressionEventsData

+ type NotificationFeed struct

+ func (f *NotificationFeed) AddActivities(activities ...Activity) (*AddActivitiesResponse, error)

+ func (f *NotificationFeed) AddActivity(activity Activity) (*AddActivityResponse, error)

+ func (f *NotificationFeed) Follow(feed *FlatFeed, opts ...FollowFeedOption) error

+ func (f *NotificationFeed) GetActivities(opts ...GetActivitiesOption) (*NotificationFeedResponse, error)

+ func (f *NotificationFeed) GetEnrichedActivities(opts ...GetActivitiesOption) (*EnrichedNotificationFeedResponse, error)

+ func (f *NotificationFeed) GetFollowing(opts ...FollowingOption) (*FollowingResponse, error)

+ func (f *NotificationFeed) GetNextPageActivities(resp *NotificationFeedResponse) (*NotificationFeedResponse, error)

+ func (f *NotificationFeed) GetNextPageEnrichedActivities(resp *EnrichedNotificationFeedResponse) (*EnrichedNotificationFeedResponse, error)

+ func (f *NotificationFeed) ID() string

+ func (f *NotificationFeed) RealtimeToken(readonly bool) string

+ func (f *NotificationFeed) RemoveActivityByForeignID(foreignID string) error

+ func (f *NotificationFeed) RemoveActivityByID(id string) error

+ func (f *NotificationFeed) Slug() string

+ func (f *NotificationFeed) Unfollow(target Feed, opts ...UnfollowOption) error

+ func (f *NotificationFeed) UpdateToTargets(activity Activity, opts ...UpdateToTargetsOption) error

+ func (f *NotificationFeed) UserID() string

+ type NotificationFeedResponse struct

+ Results []NotificationFeedResult

+ type NotificationFeedResult struct

+ Activities []Activity

+ type PersonalizationClient struct

+ func (c *PersonalizationClient) Delete(resource string, params map[string]interface{}) error

+ func (c *PersonalizationClient) Get(resource string, params map[string]interface{}) (*PersonalizationResponse, error)

+ func (c *PersonalizationClient) Post(resource string, params, data map[string]interface{}) error

+ type PersonalizationResponse struct

+ AppID int

+ Duration Duration

+ Limit int

+ Next string

+ Offset int

+ Results []map[string]interface{}

+ Version string

+ func (r *PersonalizationResponse) Extra() map[string]interface{}

+ func (r *PersonalizationResponse) UnmarshalJSON(data []byte) error

+ type Reaction struct

+ ChildrenCounters map[string]interface{}

+ ChildrenReactions map[string][]*Reaction

+ OwnChildren map[string][]*Reaction

+ type ReactionsClient struct

+ func (c *ReactionsClient) Add(r AddReactionRequestObject) (*Reaction, error)

+ func (c *ReactionsClient) AddChild(parentID string, r AddReactionRequestObject) (*Reaction, error)

+ func (c *ReactionsClient) Delete(id string) error

+ func (c *ReactionsClient) Filter(attr FilterReactionsAttribute, opts ...FilterReactionsOption) (*FilterReactionResponse, error)

+ func (c *ReactionsClient) Get(id string) (*Reaction, error)

+ func (c *ReactionsClient) GetNextPageFilteredReactions(resp *FilterReactionResponse) (*FilterReactionResponse, error)

+ func (c *ReactionsClient) Update(id string, data map[string]interface{}, targetFeeds []string) (*Reaction, error)

+ type Requester interface

+ Do func(*http.Request) (*http.Response, error)

+ type Time struct

+ func (t *Time) UnmarshalJSON(b []byte) error

+ func (t Time) MarshalJSON() ([]byte, error)

+ type UnfollowOption struct

+ func WithUnfollowKeepHistory(keepHistory bool) UnfollowOption

+ type UnfollowRelationship struct

+ KeepHistory bool

+ Source string

+ Target string

+ type UpdateActivitiesResponse struct

+ Activities []*Activity

+ type UpdateActivityRequest struct

+ ForeignID *string

+ ID *string

+ Set map[string]interface{}

+ Time *Time

+ Unset []string

+ func NewUpdateActivityRequestByForeignID(foreignID string, timestamp Time, set map[string]interface{}, unset []string) UpdateActivityRequest

+ func NewUpdateActivityRequestByID(id string, set map[string]interface{}, unset []string) UpdateActivityRequest

+ type UpdateActivityResponse struct

+ type UpdateToTargetsOption func(*updateToTargetsRequest)

+ func WithToTargetsAdd(targets ...string) UpdateToTargetsOption

+ func WithToTargetsNew(targets ...string) UpdateToTargetsOption

+ func WithToTargetsRemove(targets ...string) UpdateToTargetsOption

+ type User struct

+ Data map[string]interface{}

+ ID string

+ type UserData struct

+ func NewUserData() *UserData

+ func (d *UserData) Alias(alias string) *UserData

+ func (d *UserData) Int(id int) *UserData

+ func (d *UserData) String(id string) *UserData

+ type UsersClient struct

+ func (c *UsersClient) Add(user User, getOrCreate bool) (*User, error)

+ func (c *UsersClient) CreateReference(id string) string

+ func (c *UsersClient) Delete(id string) error

+ func (c *UsersClient) Get(id string) (*User, error)

+ func (c *UsersClient) Update(id string, data map[string]interface{}) (*User, error)

Other modules containing this package

github.com/GetStream/stream-go2

github.com/GetStream/stream-go2/v5

github.com/GetStream/stream-go2/v6

github.com/GetStream/stream-go2/v7

github.com/GetStream/stream-go2/v8

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL