stream_chat

package module

Go to main page

Versions in this module

v3

v3.14.0

Nov 17, 2021

Changes in this version

type Channel

+ func (ch *Channel) RemoveShadowBan(userID string) error

+ func (ch *Channel) ShadowBan(userID, bannedByID string, options map[string]interface{}) error

type Client

+ func (c *Client) PartialUpdateMessage(messageID string, updates PartialUpdate, options map[string]interface{}) (*Message, error)

+ func (c *Client) PinMessage(msgID, pinnedByID string, expiration *time.Time) (*Message, error)

+ func (c *Client) RemoveShadowBan(userID string, options map[string]string) error

+ func (c *Client) ShadowBan(userID, bannedByID string, options map[string]interface{}) error

+ func (c *Client) UnPinMessage(msgID, userID string) (*Message, error)

type DeleteUserOptions

+ NewChannelOwnerID string

type Message

+ PinnedAt *time.Time

+ PinnedBy *User

+ Shadowed bool

v3.13.0

Nov 1, 2021

Changes in this version

type AppConfig

+ AsyncURLEnrichEnabled bool

type AppSettings

+ AsyncURLEnrichEnabled *bool

+ type AsyncTaskResponse struct

+ TaskID string

type Client

+ func (c *Client) DeleteChannels(cids []string, hardDelete bool) (string, error)

+ func (c *Client) DeleteUsers(userIDs []string, options DeleteUserOptions) (string, error)

+ func (c *Client) ExportChannels(channels []*ExportableChannel, ...) (string, error)

+ func (c *Client) GetExportChannelsTask(taskID string) (*Task, error)

+ func (c *Client) GetTask(id string) (*Task, error)

+ type DeleteType string

+ const HardDelete

+ const SoftDelete

+ type DeleteUserOptions struct

+ Conversations DeleteType

+ Messages DeleteType

+ User DeleteType

+ type ExportableChannel struct

+ ID string

+ MessagesSince *time.Time

+ MessagesUntil *time.Time

+ Type string

+ type Task struct

+ CreatedAt time.Time

+ Result map[string]interface{}

+ Status TaskStatus

+ TaskID string

+ UpdatedAt time.Time

+ type TaskStatus string

+ const TaskStatusCompleted

+ const TaskStatusFailed

+ const TaskStatusPending

+ const TaskStatusRunning

+ const TaskStatusWaiting

v3.12.2

Sep 1, 2021

v3.12.1

Aug 19, 2021

Changes in this version

type FirebaseConfig

+ DataTemplate string

+ ServerKey string

v3.12.0

Aug 14, 2021

Changes in this version

type Client

+ func (c *Client) HardDeleteMessage(msgID string) error

v3.11.3

Jul 30, 2021

v3.11.2

Jun 30, 2021

v3.11.1

Jun 29, 2021

v3.11.0

Jun 29, 2021

Changes in this version

type ChannelConfig

+ AutomodThresholds *Thresholds

+ BlockList string

+ BlockListBehavior modBehaviour

+ CustomEvents bool

+ URLEnrichment bool

+ Uploads bool

+ type LabelThresholds struct

+ Block float32

+ Flag float32

+ type Thresholds struct

+ Explicit *LabelThresholds

+ Spam *LabelThresholds

+ Toxic *LabelThresholds

v3.10.0

Jun 25, 2021

Changes in this version

type Client

+ func (c *Client) SearchWithFullResponse(request SearchRequest) (*SearchResponse, error)

+ type SearchMessageResponse struct

+ Message *Message

type SearchRequest

+ MessageFilters map[string]interface{}

+ Next string

+ Sort []SortOption

+ type SearchResponse struct

+ Next string

+ Previous string

+ Results []SearchMessageResponse

v3.9.1

Jun 4, 2021

Changes in this version

type EventType

+ const EventChannelCreated

v3.9.0

May 31, 2021

Changes in this version

type AppConfig

+ RevokeTokensIssuedBefore *time.Time

type Client

+ func (c *Client) QueryMessageFlags(q *QueryOption) ([]*MessageFlag, error)

+ func (c *Client) RevokeTokens(before *time.Time) error

+ func (c *Client) RevokeUserToken(userID string, before *time.Time) error

+ func (c *Client) RevokeUsersTokens(userIDs []string, before *time.Time) error

+ type MessageFlag struct

+ ApprovedAt time.Time

+ CreatedAt time.Time

+ CreatedByAutomod bool

+ Message *Message

+ ModerationResult ...

+ RejectedAt time.Time

+ ReviewedAt time.Time

+ ReviewedBy *User

+ UpdatedAt time.Time

+ User *User

type User

+ RevokeTokensIssuedBefore *time.Time

v3.8.0

May 18, 2021

Changes in this version

type Channel

+ Disabled bool

v3.7.0

May 17, 2021

Changes in this version

type Client

+ func (c *Client) SendUserCustomEvent(targetUserID string, event *UserCustomEvent) error

+ type UserCustomEvent struct

+ CreatedAt time.Time

+ ExtraData map[string]interface{}

+ Type string

+ func (e *UserCustomEvent) UnmarshalJSON(data []byte) error

+ func (e UserCustomEvent) MarshalJSON() ([]byte, error)

v3.6.1

Mar 10, 2021

v3.6.0

Mar 9, 2021

Changes in this version

type ChannelConfig

+ PushNotifications bool

v3.5.0

Mar 8, 2021

Changes in this version

type Client

+ func (c *Client) GetRateLimits(options ...GetRateLimitsOption) (GetRateLimitsResponse, error)

+ type GetRateLimitsOption func(p *getRateLimitsParams)

+ func WithAndroid() GetRateLimitsOption

+ func WithEndpoints(endpoints ...string) GetRateLimitsOption

+ func WithIOS() GetRateLimitsOption

+ func WithServerSide() GetRateLimitsOption

+ func WithWeb() GetRateLimitsOption

+ type GetRateLimitsResponse struct

+ Android RateLimitsMap

+ IOS RateLimitsMap

+ ServerSide RateLimitsMap

+ Web RateLimitsMap

+ type RateLimitInfo struct

+ Limit int64

+ Remaining int64

+ Reset int64

+ func (i RateLimitInfo) ResetTime() time.Time

+ type RateLimitsMap map[string]RateLimitInfo

v3.4.0

Feb 22, 2021

Changes in this version

+ func MessageSkipPush(r *messageRequest)

+ type SendMessageOption func(*messageRequest)

v3.3.1

Feb 9, 2021

v3.3.0

Jan 22, 2021

Changes in this version

type Client

+ func (c *Client) UpsertUser(user *User) (*User, error)

+ func (c *Client) UpsertUsers(users ...*User) (map[string]*User, error)

v3.2.0

Jan 18, 2021

Changes in this version

type AppConfig

+ MultiTenantEnabled bool

type AppSettings

+ MultiTenantEnabled *bool

+ func (a *AppSettings) SetMultiTenant(b bool) *AppSettings

type Channel

+ Team string

type User

+ Teams []string

v3.1.0

Dec 19, 2020

Changes in this version

type Channel

+ func (ch *Channel) PartialUpdate(update PartialUpdate) error

+ type PartialUpdate struct

+ Set map[string]interface{}

+ Unset []string

v3.0.3

Dec 14, 2020

v3.0.2

Dec 10, 2020

v3.0.1

Nov 10, 2020

Changes in this version

type QueryOption

+ MemberLimit int

+ MessageLimit int

v3.0.0

Sep 24, 2020

Changes in this version

+ const AutoModAI

+ const AutoModDisabled

+ const AutoModSimple

+ const MessageRetentionForever

+ const ModBehaviourBlock

+ const ModBehaviourFlag

+ const PushProviderAPNS

+ const PushProviderFirebase

+ var DefaultChannelConfig = ChannelConfig

+ func Version() string

+ type APNConfig struct

+ AuthKey []byte

+ AuthType string

+ BundleID string

+ Development bool

+ Enabled bool

+ Host string

+ KeyID string

+ NotificationTemplate string

+ TeamID string

+ type AppConfig struct

+ ConfigNameMap map[string]*ChannelConfig

+ DisableAuth bool

+ DisablePermissions bool

+ Name string

+ OrganizationName string

+ Policies map[string][]Policy

+ PushNotifications PushNotificationFields

+ Suspended bool

+ SuspendedExplanation string

+ WebhookURL string

+ type AppSettings struct

+ APNConfig *APNConfig

+ DisableAuth *bool

+ DisablePermissions *bool

+ FirebaseConfig *FirebaseConfig

+ WebhookURL *string

+ func NewAppSettings() *AppSettings

+ func (a *AppSettings) SetAPNConfig(c APNConfig) *AppSettings

+ func (a *AppSettings) SetDisableAuth(b bool) *AppSettings

+ func (a *AppSettings) SetDisablePermissions(b bool) *AppSettings

+ func (a *AppSettings) SetFirebaseConfig(c FirebaseConfig) *AppSettings

+ func (a *AppSettings) SetWebhookURL(s string) *AppSettings

+ type Attachment struct

+ AssetURL string

+ AuthorName string

+ ExtraData map[string]interface{}

+ ImageURL string

+ OGScrapeURL string

+ Text string

+ ThumbURL string

+ Title string

+ TitleLink string

+ Type string

+ func (a *Attachment) UnmarshalJSON(data []byte) error

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

+ type Channel struct

+ CID string

+ Config ChannelConfig

+ CreatedAt time.Time

+ CreatedBy *User

+ ExtraData map[string]interface{}

+ Frozen bool

+ ID string

+ LastMessageAt time.Time

+ MemberCount int

+ Members []*ChannelMember

+ Messages []*Message

+ Read []*ChannelRead

+ Type string

+ UpdatedAt time.Time

+ func (ch *Channel) AcceptInvite(userID string, message *Message) error

+ func (ch *Channel) AddMembers(userIDs []string, message *Message) error

+ func (ch *Channel) AddModerators(userIDs ...string) error

+ func (ch *Channel) AddModeratorsWithMessage(userIDs []string, msg *Message) error

+ func (ch *Channel) BanUser(targetID, userID string, options map[string]interface{}) error

+ func (ch *Channel) Delete() error

+ func (ch *Channel) DeleteFile(location string) error

+ func (ch *Channel) DeleteImage(location string) error

+ func (ch *Channel) DeleteReaction(messageID, reactionType, userID string) (*Message, error)

+ func (ch *Channel) DemoteModerators(userIDs ...string) error

+ func (ch *Channel) DemoteModeratorsWithMessage(userIDs []string, msg *Message) error

+ func (ch *Channel) GetReactions(messageID string, options map[string][]string) ([]*Reaction, error)

+ func (ch *Channel) GetReplies(parentID string, options map[string][]string) ([]*Message, error)

+ func (ch *Channel) Hide(userID string) error

+ func (ch *Channel) HideWithHistoryClear(userID string) error

+ func (ch *Channel) ImportMessages(messages ...*Message) (*ImportChannelMessagesResponse, error)

+ func (ch *Channel) InviteMembers(userIDs ...string) error

+ func (ch *Channel) InviteMembersWithMessage(userIDs []string, msg *Message) error

+ func (ch *Channel) MarkRead(userID string, options map[string]interface{}) error

+ func (ch *Channel) Mute(userID string, expiration *time.Duration) (*ChannelMuteResponse, error)

+ func (ch *Channel) Query(data map[string]interface{}) error

+ func (ch *Channel) QueryMembers(q *QueryOption, sorters ...*SortOption) ([]*ChannelMember, error)

+ func (ch *Channel) RejectInvite(userID string, message *Message) error

+ func (ch *Channel) RemoveMembers(userIDs []string, message *Message) error

+ func (ch *Channel) SendAction(msgID string, formData map[string]string) (*Message, error)

+ func (ch *Channel) SendEvent(event *Event, userID string) error

+ func (ch *Channel) SendFile(request SendFileRequest) (string, error)

+ func (ch *Channel) SendImage(request SendFileRequest) (string, error)

+ func (ch *Channel) SendMessage(message *Message, userID string) (*Message, error)

+ func (ch *Channel) SendReaction(reaction *Reaction, messageID, userID string) (*Message, error)

+ func (ch *Channel) Show(userID string) error

+ func (ch *Channel) Truncate() error

+ func (ch *Channel) UnBanUser(targetID string, options map[string]string) error

+ func (ch *Channel) UnmarshalJSON(data []byte) error

+ func (ch *Channel) Unmute(userID string) error

+ func (ch *Channel) Update(options map[string]interface{}, message *Message) error

+ func (ch Channel) MarshalJSON() ([]byte, error)

+ type ChannelConfig struct

+ Automod modType

+ ConnectEvents bool

+ MaxMessageLength int

+ MessageRetention string

+ ModBehavior modBehaviour

+ Mutes bool

+ Name string

+ Reactions bool

+ ReadEvents bool

+ Replies bool

+ Search bool

+ TypingEvents bool

+ type ChannelMember struct

+ CreatedAt time.Time

+ InviteAcceptedAt *time.Time

+ InviteRejectedAt *time.Time

+ Invited bool

+ IsModerator bool

+ Role string

+ UpdatedAt time.Time

+ User *User

+ UserID string

+ type ChannelMute struct

+ Channel Channel

+ CreatedAt time.Time

+ Expires *time.Time

+ UpdatedAt time.Time

+ User User

+ type ChannelMuteResponse struct

+ ChannelMute ChannelMute

+ type ChannelRead struct

+ LastRead time.Time

+ User *User

+ type ChannelType struct

+ Commands []*Command

+ CreatedAt time.Time

+ Permissions []*Permission

+ UpdatedAt time.Time

+ func NewChannelType(name string) *ChannelType

+ type Client struct

+ BaseURL string

+ HTTP *http.Client

+ func NewClient(apiKey, apiSecret string) (*Client, error)

+ func (c *Client) AddDevice(device *Device) error

+ func (c *Client) BanUser(targetID, userID string, options map[string]interface{}) error

+ func (c *Client) Channel(channelType, channelID string) *Channel

+ func (c *Client) CreateChannel(chanType, chanID, userID string, data map[string]interface{}) (*Channel, error)

+ func (c *Client) CreateChannelType(chType *ChannelType) (*ChannelType, error)

+ func (c *Client) CreateCommand(cmd *Command) (*Command, error)

+ func (c *Client) CreateToken(userID string, expire time.Time) (string, error)

+ func (c *Client) DeactivateUser(targetID string, options map[string]interface{}) error

+ func (c *Client) DeleteChannelType(name string) error

+ func (c *Client) DeleteCommand(cmdName string) error

+ func (c *Client) DeleteDevice(userID, deviceID string) error

+ func (c *Client) DeleteMessage(msgID string) error

+ func (c *Client) DeleteUser(targetID string, options map[string][]string) error

+ func (c *Client) ExportUser(targetID string, options map[string][]string) (user *User, err error)

+ func (c *Client) FlagMessage(msgID string) error

+ func (c *Client) FlagUser(targetID string, options map[string]interface{}) error

+ func (c *Client) GetAppConfig() (*AppConfig, error)

+ func (c *Client) GetChannelType(chanType string) (*ChannelType, error)

+ func (c *Client) GetCommand(cmdName string) (*Command, error)

+ func (c *Client) GetDevices(userID string) (devices []*Device, err error)

+ func (c *Client) GetMessage(msgID string) (*Message, error)

+ func (c *Client) ListChannelTypes() (map[string]*ChannelType, error)

+ func (c *Client) ListCommands() ([]*Command, error)

+ func (c *Client) MarkAllRead(userID string) error

+ func (c *Client) MuteUser(targetID, userID string, options map[string]interface{}) error

+ func (c *Client) MuteUsers(targetIDs []string, userID string, options map[string]interface{}) error

+ func (c *Client) PartialUpdateUser(update PartialUserUpdate) (*User, error)

+ func (c *Client) PartialUpdateUsers(updates []PartialUserUpdate) (map[string]*User, error)

+ func (c *Client) QueryChannels(q *QueryOption, sort ...*SortOption) ([]*Channel, error)

+ func (c *Client) QueryUsers(q *QueryOption, sorters ...*SortOption) ([]*User, error)

+ func (c *Client) ReactivateUser(targetID string, options map[string]interface{}) error

+ func (c *Client) Search(request SearchRequest) ([]*Message, error)

+ func (c *Client) UnBanUser(targetID string, options map[string]string) error

+ func (c *Client) UnFlagUser(targetID string, options map[string]interface{}) error

+ func (c *Client) UnflagMessage(msgID string) error

+ func (c *Client) UnmuteUser(targetID, userID string) error

+ func (c *Client) UnmuteUsers(targetIDs []string, userID string) error

+ func (c *Client) UpdateAppSettings(settings *AppSettings) error

+ func (c *Client) UpdateChannelType(name string, options map[string]interface{}) error

+ func (c *Client) UpdateCommand(cmdName string, options map[string]interface{}) (*Command, error)

+ func (c *Client) UpdateMessage(msg *Message, msgID string) (*Message, error)

+ func (c *Client) UpdateUser(user *User) (*User, error)

+ func (c *Client) UpdateUsers(users ...*User) (map[string]*User, error)

+ func (c *Client) VerifyWebhook(body, signature []byte) (valid bool)

+ type Command struct

+ Args string

+ Description string

+ Name string

+ Set string

+ type Device struct

+ ID string

+ PushProvider pushProvider

+ UserID string

+ type Event struct

+ CID string

+ Channel *Channel

+ CreatedAt time.Time

+ ExtraData map[string]interface{}

+ Member *ChannelMember

+ Members []*ChannelMember

+ Message *Message

+ OwnUser *User

+ Reaction *Reaction

+ Type EventType

+ User *User

+ UserID string

+ WatcherCount int

+ func (e *Event) UnmarshalJSON(data []byte) error

+ func (e Event) MarshalJSON() ([]byte, error)

+ type EventType string

+ const EventChannelDeleted

+ const EventChannelTruncated

+ const EventChannelUpdated

+ const EventHealthCheck

+ const EventMemberAdded

+ const EventMemberRemoved

+ const EventMemberUpdated

+ const EventMessageDeleted

+ const EventMessageNew

+ const EventMessageRead

+ const EventMessageUpdated

+ const EventNotificationAddedToChannel

+ const EventNotificationInviteAccepted

+ const EventNotificationInvited

+ const EventNotificationMarkRead

+ const EventNotificationMutesUpdated

+ const EventNotificationNewMessage

+ const EventNotificationRemovedFromChannel

+ const EventReactionDeleted

+ const EventReactionNew

+ const EventTypingStart

+ const EventTypingStop

+ const EventUserMuted

+ const EventUserPresenceChanged

+ const EventUserUnmuted

+ const EventUserUpdated

+ const EventUserWatchingStart

+ const EventUserWatchingStop

+ type FirebaseConfig struct

+ Enabled bool

+ NotificationTemplate string

+ type ImportChannelMessagesResponse struct

+ Messages []Message

+ type Message struct

+ Attachments []*Attachment

+ CreatedAt *time.Time

+ DeletedAt *time.Time

+ ExtraData map[string]interface{}

+ HTML string

+ ID string

+ LatestReactions []*Reaction

+ MentionedUsers []*User

+ OwnReactions []*Reaction

+ ParentID string

+ ReactionCounts map[string]int

+ ReplyCount int

+ ShowInChannel bool

+ Silent bool

+ Text string

+ Type MessageType

+ UpdatedAt *time.Time

+ User *User

+ func (m *Message) UnmarshalJSON(data []byte) error

+ func (m Message) MarshalJSON() ([]byte, error)

+ type MessageType string

+ const MessageTypeEphemeral

+ const MessageTypeError

+ const MessageTypeRegular

+ const MessageTypeReply

+ const MessageTypeSystem

+ type Mute struct

+ CreatedAt time.Time

+ Expires *time.Time

+ Target User

+ UpdatedAt time.Time

+ User User

+ type PartialUserUpdate struct

+ ID string

+ Set map[string]interface{}

+ Unset []string

+ type Permission struct

+ Action string

+ Name string

+ Owner bool

+ Priority int

+ Resources []string

+ Roles []string

+ type Policy struct

+ Action int

+ CreatedAt time.Time

+ Name string

+ Owner bool

+ Priority int

+ Resources []string

+ Roles []string

+ UpdatedAt time.Time

+ type PushNotificationFields struct

+ APNConfig APNConfig

+ FirebaseConfig FirebaseConfig

+ type QueryOption struct

+ Filter map[string]interface{}

+ Limit int

+ Offset int

+ Sort []*SortOption

+ UserID string

+ type Reaction struct

+ ExtraData map[string]interface{}

+ MessageID string

+ Type string

+ UserID string

+ func (s *Reaction) UnmarshalJSON(data []byte) error

+ func (s Reaction) MarshalJSON() ([]byte, error)

+ type SearchRequest struct

+ Filters map[string]interface{}

+ Limit int

+ Offset int

+ Query string

+ type SendFileRequest struct

+ ContentType string

+ FileName string

+ Reader io.Reader

+ User *User

+ type SortOption struct

+ Direction int

+ Field string

+ type User struct

+ ChannelMutes []*ChannelMute

+ CreatedAt *time.Time

+ ExtraData map[string]interface{}

+ ID string

+ Image string

+ Invisible bool

+ LastActive *time.Time

+ Mutes []*Mute

+ Name string

+ Online bool

+ Role string

+ UpdatedAt *time.Time

+ func (u *User) UnmarshalJSON(data []byte) error

+ func (u User) MarshalJSON() ([]byte, error)

Other modules containing this package

github.com/GetStream/stream-chat-go

github.com/GetStream/stream-chat-go/v2

github.com/GetStream/stream-chat-go/v4

github.com/GetStream/stream-chat-go/v5

github.com/GetStream/stream-chat-go/v6

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