Versions in this module Expand all Collapse all v3 v3.11.4 Jul 22, 2021 Changes in this version + const AutoModAI + const AutoModDisabled + const AutoModSimple + const MessageRetentionForever + const ModBehaviourBlock + const ModBehaviourFlag + const PushProviderAPNS + const PushProviderFirebase + var DefaultChannelConfig = ChannelConfig + func MessageSkipPush(r *messageRequest) + 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 + MultiTenantEnabled bool + Name string + OrganizationName string + Policies map[string][]Policy + PushNotifications PushNotificationFields + RevokeTokensIssuedBefore *time.Time + Suspended bool + SuspendedExplanation string + WebhookURL string + type AppSettings struct + APNConfig *APNConfig + DisableAuth *bool + DisablePermissions *bool + FirebaseConfig *FirebaseConfig + MultiTenantEnabled *bool + 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) SetMultiTenant(b bool) *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 + Disabled bool + ExtraData map[string]interface{} + Frozen bool + ID string + LastMessageAt time.Time + MemberCount int + Members []*ChannelMember + Messages []*Message + Read []*ChannelRead + Team string + 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) PartialUpdate(update PartialUpdate) 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, options ...SendMessageOption) (*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 + AutomodThresholds *Thresholds + BlockList string + BlockListBehavior modBehaviour + ConnectEvents bool + CustomEvents bool + MaxMessageLength int + MessageRetention string + ModBehavior modBehaviour + Mutes bool + Name string + PushNotifications bool + Reactions bool + ReadEvents bool + Replies bool + Search bool + TypingEvents bool + URLEnrichment bool + Uploads 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, issuedAt ...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, userID 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) GetRateLimits(options ...GetRateLimitsOption) (GetRateLimitsResponse, 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) QueryMessageFlags(q *QueryOption) ([]*MessageFlag, 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) 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 + func (c *Client) Search(request SearchRequest) ([]*Message, error) + func (c *Client) SearchWithFullResponse(request SearchRequest) (*SearchResponse, error) + func (c *Client) SendUserCustomEvent(targetUserID string, event *UserCustomEvent) 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, userID 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) UpsertUser(user *User) (*User, error) + func (c *Client) UpsertUsers(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 EventChannelCreated + 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 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 ImportChannelMessagesResponse struct + Messages []Message + type LabelThresholds struct + Block float32 + Flag float32 + 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 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 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 PartialUpdate struct + Set map[string]interface{} + Unset []string + 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 + MemberLimit *int + MessageLimit *int + Offset int + Sort []*SortOption + UserID string + type RateLimitInfo struct + Limit int64 + Remaining int64 + Reset int64 + func (i RateLimitInfo) ResetTime() time.Time + type RateLimitsMap map[string]RateLimitInfo + 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 SearchMessageResponse struct + Message *Message + type SearchRequest struct + Filters map[string]interface{} + Limit int + MessageFilters map[string]interface{} + Next string + Offset int + Query string + Sort []SortOption + type SearchResponse struct + Next string + Previous string + Results []SearchMessageResponse + type SendFileRequest struct + ContentType string + FileName string + Reader io.Reader + User *User + type SendMessageOption func(*messageRequest) + type SortOption struct + Direction int + Field string + type Thresholds struct + Explicit *LabelThresholds + Spam *LabelThresholds + Toxic *LabelThresholds + type User struct + ChannelLastReadAt *time.Time + ChannelMutes []*ChannelMute + ChannelUnreadCount int + CreatedAt *time.Time + ExtraData map[string]interface{} + ID string + Image string + Invisible bool + LastActive *time.Time + Mutes []*Mute + Name string + Online bool + RevokeTokensIssuedBefore *time.Time + Role string + Teams []string + TotalUnreadCount int + UnreadChannels int + UnreadCount int + UpdatedAt *time.Time + func (u *User) UnmarshalJSON(data []byte) error + func (u User) MarshalJSON() ([]byte, 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) Other modules containing this package github.com/tpoxa/stream-chat-go/v6
Go to main page