stream_chat

package module
v5.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 8, 2022 License: BSD-3-Clause Imports: 21 Imported by: 14

README

Official Go SDK for Stream Chat

build godoc

Official Go API client for Stream Chat, a service for building chat applications.
Explore the docs »

Report Bug · Request Feature

📝 About Stream

You can sign up for a Stream account at our Get Started page.

You can use this library to access chat API endpoints server-side.

For the client-side integrations (web and mobile) have a look at the JavaScript, iOS and Android SDK libraries (docs).

⚙️ Installation

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

✨ Getting started

package main

import (
	"os"

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

var APIKey = os.Getenv("STREAM_KEY")
var APISecret = os.Getenv("STREAM_SECRET")
var userID = "" // your server user id

func main() {
	// Initialize client
	client, err := stream.NewClient(APIKey, APISecret)
	
	// Or with a specific timeout
	client, err := stream.NewClient(APIKey, APISecret, WithTimeout(3 * time.Second))

	// Or using only environmental variables: (required) STREAM_KEY, (required) STREAM_SECRET,
	// (optional) STREAM_CHAT_TIMEOUT
	client, err := stream.NewClientFromEnvVars()

	// handle error

	// use client methods

	// create channel with users
	users := []string{"id1", "id2", "id3"}
	channel, err := client.CreateChannelWithMembers(ctx, "messaging", "channel-id", userID, users...)

	// use channel methods
	msg, err := channel.SendMessage(ctx, &stream.Message{Text: "hello"}, userID)
}

✍️ Contributing

We welcome code changes that improve this library or fix a problem, please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github. We are very happy to merge your code in the official repository. Make sure to sign our Contributor License Agreement (CLA) first. See our license file for more details.

Head over to CONTRIBUTING.md for some development tips.

🧑‍💻 We are hiring!

We've recently closed a $38 million Series B funding round and we keep actively growing. Our APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world.

Check out our current openings and apply via Stream's website.

Documentation

Index

Examples

Constants

View Source 
const (
	AutoModDisabled modType = "disabled"
	AutoModSimple   modType = "simple"
	AutoModAI       modType = "AI"

	ModBehaviourFlag  modBehaviour = "flag"
	ModBehaviourBlock modBehaviour = "block"

	MessageRetentionForever = "infinite"
)
View Source 
const (
	PushProviderAPNS     = PushProviderType("apn")
	PushProviderFirebase = PushProviderType("firebase")
	PushProviderXiaomi   = PushProviderType("xiaomi")
	PushProviderHuawei   = PushProviderType("huawei")
)
View Source 
const (
	HeaderRateLimit     = "X-Ratelimit-Limit"
	HeaderRateRemaining = "X-Ratelimit-Remaining"
	HeaderRateReset     = "X-Ratelimit-Reset"
)
View Source 
const (
	// DefaultBaseURL is the default base URL for the stream chat api.
	// It works like CDN style and connects you to the closest production server.
	// By default, there is no real reason to change it. Use it only if you know what you are doing.
	DefaultBaseURL = "https://chat.stream-io-api.com"
)

Variables

View Source 
var DefaultChannelConfig = ChannelConfig{
	Automod:           AutoModDisabled,
	ModBehavior:       ModBehaviourFlag,
	MaxMessageLength:  defaultMessageLength,
	MessageRetention:  MessageRetentionForever,
	PushNotifications: true,
}

DefaultChannelConfig is the default channel configuration.

Functions

func AddMembersWithHideHistory 

func AddMembersWithHideHistory() func(*addMembersOptions)

func AddMembersWithMessage 

func AddMembersWithMessage(message *Message) func(*addMembersOptions)

func AddMembersWithRolesAssignment 

func AddMembersWithRolesAssignment(assignements []*RoleAssignment) func(*addMembersOptions)

func BanWithExpiration 

func BanWithExpiration(expiration int) func(*banOptions)

BanWithExpiration set when the ban will expire. Should be in minutes. eg. to ban during one hour: BanWithExpiration(60).

func BanWithReason 

func BanWithReason(reason string) func(*banOptions)

func DeactivateUserWithCreatedBy 

func DeactivateUserWithCreatedBy(userID string) func(*deactivateUserOptions)

func DeactivateUserWithMarkMessagesDeleted 

func DeactivateUserWithMarkMessagesDeleted() func(*deactivateUserOptions)

func DeleteUserWithDeleteConversations 

func DeleteUserWithDeleteConversations() func(*deleteUserOptions)

func DeleteUserWithHardDelete 

func DeleteUserWithHardDelete() func(*deleteUserOptions)

func DeleteUserWithMarkMessagesDeleted 

func DeleteUserWithMarkMessagesDeleted() func(*deleteUserOptions)

func MarkReadUntilMessage 

func MarkReadUntilMessage(id string) func(*markReadOption)

func MessageSkipPush 

func MessageSkipPush(r *messageRequest)

MessageSkipPush is a flag that be given to SendMessage if you don't want to generate any push notifications.

func MuteWithExpiration 

func MuteWithExpiration(expiration int) func(*muteOptions)

func ReactivateUserWithCreatedBy 

func ReactivateUserWithCreatedBy(userID string) func(*reactivateUserOptions)

func ReactivateUserWithName 

func ReactivateUserWithName(name string) func(*reactivateUserOptions)

func ReactivateUserWithRestoreMessages 

func ReactivateUserWithRestoreMessages() func(*reactivateUserOptions)

func TruncateWithHardDelete 

func TruncateWithHardDelete() func(*truncateOptions)

func TruncateWithMessage 

func TruncateWithMessage(message *Message) func(*truncateOptions)

func TruncateWithSkipPush 

func TruncateWithSkipPush() func(*truncateOptions)

func TruncateWithTruncatedAt 

func TruncateWithTruncatedAt(truncatedAt *time.Time) func(*truncateOptions)

func TruncateWithUser added in v5.8.0 

func TruncateWithUser(user *User) func(*truncateOptions)

func TruncateWithUserID added in v5.8.0 

func TruncateWithUserID(userID string) func(*truncateOptions)

func Version 

func Version() string

Version returns the version of the library.

func WithTimeout added in v5.7.0 

func WithTimeout(t time.Duration) func(c *Client)

Types

type APNConfig 

type APNConfig struct {
	Enabled              bool   `json:"enabled"`
	Development          bool   `json:"development"`
	AuthType             string `json:"auth_type,omitempty"`
	AuthKey              string `json:"auth_key,omitempty"`
	NotificationTemplate string `json:"notification_template"`
	Host                 string `json:"host,omitempty"`
	BundleID             string `json:"bundle_id,omitempty"`
	TeamID               string `json:"team_id,omitempty"`
	KeyID                string `json:"key_id,omitempty"`
}

type AddMembersOptions 

type AddMembersOptions func(*addMembersOptions)

type AppConfig 

type AppConfig struct {
	Name                      string                    `json:"name"`
	OrganizationName          string                    `json:"organization"`
	WebhookURL                string                    `json:"webhook_url"`
	SuspendedExplanation      string                    `json:"suspended_explanation"`
	PushNotifications         PushNotificationFields    `json:"push_notifications"`
	ConfigNameMap             map[string]*ChannelConfig `json:"channel_configs"`
	Policies                  map[string][]Policy       `json:"policies"`
	Suspended                 bool                      `json:"suspended"`
	DisableAuth               bool                      `json:"disable_auth_checks"`
	DisablePermissions        bool                      `json:"disable_permissions_checks"`
	MultiTenantEnabled        bool                      `json:"multi_tenant_enabled"`
	RevokeTokensIssuedBefore  *time.Time                `json:"revoke_tokens_issued_before"`
	RemindersInterval         int                       `json:"reminders_interval"`
	AsyncURLEnrichEnabled     bool                      `json:"async_url_enrich_enabled"`
	Grants                    map[string][]string       `json:"grants"`
	PermissionVersion         string                    `json:"permission_version"`
	ImageModerationLabels     []string                  `json:"image_moderation_labels"`
	ImageModerationEnabled    *bool                     `json:"image_moderation_enabled"`
	BeforeMessageSendHookURL  string                    `json:"before_message_send_hook_url"`
	CustomActionHandlerURL    string                    `json:"custom_action_handler_url"`
	UserSearchDisallowedRoles []string                  `json:"user_search_disallowed_roles"`
	EnforceUniqueUsernames    string                    `json:"enforce_unique_usernames"`
	SqsURL                    string                    `json:"sqs_url"`
	SqsKey                    string                    `json:"sqs_key"`
	SqsSecret                 string                    `json:"sqs_secret"`
	WebhookEvents             []string                  `json:"webhook_events"`
}

type AppResponse 

type AppResponse struct {
	App *AppConfig `json:"app"`
	Response
}

type AppSettings 

type AppSettings struct {
	DisableAuth               *bool                  `json:"disable_auth_checks,omitempty"`
	DisablePermissions        *bool                  `json:"disable_permissions_checks,omitempty"`
	APNConfig                 *APNConfig             `json:"apn_config,omitempty"`
	FirebaseConfig            *FirebaseConfigRequest `json:"firebase_config,omitempty"`
	XiaomiConfig              *XiaomiConfigRequest   `json:"xiaomi_config,omitempty"`
	HuaweiConfig              *HuaweiConfigRequest   `json:"huawei_config,omitempty"`
	PushConfig                *PushConfigRequest     `json:"push_config,omitempty"`
	WebhookURL                string                 `json:"webhook_url,omitempty"`
	MultiTenantEnabled        *bool                  `json:"multi_tenant_enabled,omitempty"`
	AsyncURLEnrichEnabled     *bool                  `json:"async_url_enrich_enabled,omitempty"`
	AutoTranslationEnabled    *bool                  `json:"auto_translation_enabled,omitempty"`
	Grants                    map[string][]string    `json:"grants,omitempty"`
	MigratePermissionsToV2    *bool                  `json:"migrate_permissions_to_v2,omitempty"`
	PermissionVersion         string                 `json:"permission_version,omitempty"`
	FileUploadConfig          *FileUploadConfig      `json:"file_upload_config,omitempty"`
	ImageUploadConfig         *FileUploadConfig      `json:"image_upload_config,omitempty"`
	ImageModerationLabels     []string               `json:"image_moderation_labels,omitempty"`
	ImageModerationEnabled    *bool                  `json:"image_moderation_enabled,omitempty"`
	RemindersInterval         int                    `json:"reminders_interval,omitempty"`
	BeforeMessageSendHookURL  string                 `json:"before_message_send_hook_url,omitempty"`
	CustomActionHandlerURL    string                 `json:"custom_action_handler_url,omitempty"`
	UserSearchDisallowedRoles []string               `json:"user_search_disallowed_roles,omitempty"`
	EnforceUniqueUsernames    string                 `json:"enforce_unique_usernames,omitempty"`
	SqsURL                    string                 `json:"sqs_url,omitempty"`
	SqsKey                    string                 `json:"sqs_key,omitempty"`
	SqsSecret                 string                 `json:"sqs_secret,omitempty"`
	WebhookEvents             []string               `json:"webhook_events,omitempty"`
	ChannelHideMembersOnly    *bool                  `json:"channel_hide_members_only,omitempty"`
}

func NewAppSettings 

func NewAppSettings() *AppSettings

func (*AppSettings) SetAPNConfig 

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

func (*AppSettings) SetDisableAuth 

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

func (*AppSettings) SetDisablePermissions 

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

func (*AppSettings) SetFirebaseConfig 

func (a *AppSettings) SetFirebaseConfig(c FirebaseConfigRequest) *AppSettings

func (*AppSettings) SetGrants 

func (a *AppSettings) SetGrants(g map[string][]string) *AppSettings

func (*AppSettings) SetMultiTenant 

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

func (*AppSettings) SetWebhookURL 

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

type AsyncTaskResponse 

type AsyncTaskResponse struct {
	TaskID string `json:"task_id"`
	Response
}

type Attachment 

type Attachment struct {
	Type string `json:"type,omitempty"` // text, image, audio, video

	AuthorName string `json:"author_name,omitempty"`
	Title      string `json:"title,omitempty"`
	TitleLink  string `json:"title_link,omitempty"`
	Text       string `json:"text,omitempty"`

	ImageURL    string `json:"image_url,omitempty"`
	ThumbURL    string `json:"thumb_url,omitempty"`
	AssetURL    string `json:"asset_url,omitempty"`
	OGScrapeURL string `json:"og_scrape_url,omitempty"`

	ExtraData map[string]interface{} `json:"-"`
}

func (Attachment) MarshalJSON 

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

MarshalJSON implements json.Marshaler.

func (*Attachment) UnmarshalJSON 

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

UnmarshalJSON implements json.Unmarshaler.

type Ban 

type Ban struct {
	Channel   *Channel   `json:"channel,omitempty"`
	User      *User      `json:"user"`
	Expires   *time.Time `json:"expires,omitempty"`
	Reason    string     `json:"reason,omitempty"`
	Shadow    bool       `json:"shadow,omitempty"`
	BannedBy  *User      `json:"banned_by,omitempty"`
	CreatedAt time.Time  `json:"created_at"`
}

type BanOption 

type BanOption func(*banOptions)

type Blocklist 

type Blocklist struct {
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
	BlocklistBase
}

type BlocklistBase 

type BlocklistBase struct {
	Name  string   `json:"name"`
	Words []string `json:"words"`
}

type BlocklistCreateRequest 

type BlocklistCreateRequest struct {
	BlocklistBase
}

type Channel 

type Channel struct {
	ID   string `json:"id"`
	Type string `json:"type"`
	CID  string `json:"cid"` // full id in format channel_type:channel_ID
	Team string `json:"team"`

	Config ChannelConfig `json:"config"`

	CreatedBy *User `json:"created_by"`
	Disabled  bool  `json:"disabled"`
	Frozen    bool  `json:"frozen"`

	MemberCount int              `json:"member_count"`
	Members     []*ChannelMember `json:"members"`

	Messages       []*Message     `json:"messages"`
	PinnedMessages []*Message     `json:"pinned_messages"`
	Read           []*ChannelRead `json:"read"`

	CreatedAt     time.Time `json:"created_at"`
	UpdatedAt     time.Time `json:"updated_at"`
	LastMessageAt time.Time `json:"last_message_at"`

	TruncatedBy *User      `json:"truncated_by"`
	TruncatedAt *time.Time `json:"truncated_at"`

	ExtraData map[string]interface{} `json:"-"`
	// contains filtered or unexported fields
}

func (*Channel) AcceptInvite 

func (ch *Channel) AcceptInvite(ctx context.Context, userID string, message *Message) (*Response, error)

AcceptInvite accepts an invite to the channel.

func (*Channel) AddMembers 

func (ch *Channel) AddMembers(ctx context.Context, userIDs []string, options ...AddMembersOptions) (*Response, error)

AddMembers adds members with given user IDs to the channel.

func (*Channel) AddModerators 

func (ch *Channel) AddModerators(ctx context.Context, userIDs ...string) (*Response, error)

AddModerators adds moderators with given IDs to the channel.

Example

See https://getstream.io/chat/docs/channel_members/ for more details. 

channel := &Channel{}
newModerators := []string{"bob", "sue"}
ctx := context.Background()

_, _ = channel.AddModerators(ctx, "thierry", "josh")
_, _ = channel.AddModerators(ctx, newModerators...)
_, _ = channel.DemoteModerators(ctx, newModerators...)

Output:

func (*Channel) AddModeratorsWithMessage 

func (ch *Channel) AddModeratorsWithMessage(ctx context.Context, userIDs []string, msg *Message) (*Response, error)

AddModerators adds moderators with given IDs to the channel and produce system message.

func (*Channel) AssignRole 

func (ch *Channel) AssignRole(ctx context.Context, assignments []*RoleAssignment, msg *Message) (*Response, error)

AssignRoles assigns roles to members with given IDs.

func (*Channel) BanUser 

func (ch *Channel) BanUser(ctx context.Context, targetID, bannedBy string, options ...BanOption) (*Response, error)

BanUser bans targetID on the channel ch.

func (*Channel) Delete 

func (ch *Channel) Delete(ctx context.Context) (*Response, error)

Delete removes the channel. Messages are permanently removed.

func (*Channel) DeleteFile 

func (ch *Channel) DeleteFile(ctx context.Context, location string) (*Response, error)

DeleteFile removes uploaded file.

func (*Channel) DeleteImage 

func (ch *Channel) DeleteImage(ctx context.Context, location string) (*Response, error)

DeleteImage removes uploaded image.

func (*Channel) DeleteReaction 

func (ch *Channel) DeleteReaction(ctx context.Context, messageID, reactionType, userID string) (*ReactionResponse, error)

DeleteReaction removes a reaction from message with given ID. Deprecated: DeleteReaction is deprecated, use client.DeleteReaction instead.

func (*Channel) DemoteModerators 

func (ch *Channel) DemoteModerators(ctx context.Context, userIDs ...string) (*Response, error)

DemoteModerators moderators with given IDs from the channel.

func (*Channel) DemoteModeratorsWithMessage 

func (ch *Channel) DemoteModeratorsWithMessage(ctx context.Context, userIDs []string, msg *Message) (*Response, error)

DemoteModerators moderators with given IDs from the channel and produce system message.

func (*Channel) GetMessages 

func (ch *Channel) GetMessages(ctx context.Context, messageIds []string) (*GetMessagesResponse, error)

GetMessages returns messages for multiple message ids.

func (*Channel) GetReplies 

func (ch *Channel) GetReplies(ctx context.Context, parentID string, options map[string][]string) (*RepliesResponse, error)

GetReplies returns list of the message replies for a parent message. options: Pagination params, ie {limit:10, idlte: 10}

func (*Channel) Hide 

func (ch *Channel) Hide(ctx context.Context, userID string) (*Response, error)

Hide makes channel hidden for userID.

func (*Channel) HideWithHistoryClear 

func (ch *Channel) HideWithHistoryClear(ctx context.Context, userID string) (*Response, error)

HideWithHistoryClear clear marks channel as hidden and remove all messages for user.

func (*Channel) InviteMembers 

func (ch *Channel) InviteMembers(ctx context.Context, userIDs ...string) (*Response, error)

InviteMembers invites users with given IDs to the channel.

func (*Channel) InviteMembersWithMessage 

func (ch *Channel) InviteMembersWithMessage(ctx context.Context, userIDs []string, msg *Message) (*Response, error)

InviteMembers invites users with given IDs to the channel and produce system message.

func (*Channel) MarkRead 

func (ch *Channel) MarkRead(ctx context.Context, userID string, options ...MarkReadOption) (*Response, error)

MarkRead sends the mark read event for user with given ID, only works if the `read_events` setting is enabled.

func (Channel) MarshalJSON 

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

MarshalJSON implements json.Marshaler.

func (*Channel) Mute 

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

Mute mutes the channel. The user will stop receiving messages from the channel.

func (*Channel) PartialUpdate 

func (ch *Channel) PartialUpdate(ctx context.Context, update PartialUpdate) (*Response, error)

PartialUpdate set and unset specific fields when it is necessary to retain additional custom data fields on the object. AKA a patch style update.

func (*Channel) Query 

func (ch *Channel) Query(ctx context.Context, q *QueryRequest) (*QueryResponse, error)

Query makes request to channel api and updates channel internal state.

Example 
ctx := context.Background()
channel := &Channel{}
msg, _ := channel.SendMessage(ctx, &Message{Text: "test message", Pinned: true}, channel.CreatedBy.ID)

q := &QueryRequest{
	Messages: &MessagePaginationParamsRequest{PaginationParamsRequest: PaginationParamsRequest{Limit: 1, IDLT: msg.Message.ID}},
	Members:  &PaginationParamsRequest{Limit: 1, Offset: 0},
	Watchers: &PaginationParamsRequest{Limit: 1, Offset: 0},
}
_, _ = channel.Query(ctx, q)

Output:

func (*Channel) QueryMembers 

func (ch *Channel) QueryMembers(ctx context.Context, q *QueryOption, sorters ...*SortOption) (*QueryMembersResponse, error)

QueryMembers queries members of a channel.

func (*Channel) RefreshState added in v5.1.0 

func (ch *Channel) RefreshState(ctx context.Context) (*QueryResponse, error)

RefreshState makes request to channel api and updates channel internal state.

func (*Channel) RejectInvite 

func (ch *Channel) RejectInvite(ctx context.Context, userID string, message *Message) (*Response, error)

RejectInvite rejects an invite to the channel.

func (*Channel) RemoveMembers 

func (ch *Channel) RemoveMembers(ctx context.Context, userIDs []string, message *Message) (*Response, error)

RemoveMembers deletes members with given IDs from the channel.

func (*Channel) SendAction 

func (ch *Channel) SendAction(ctx context.Context, msgID string, formData map[string]string) (*MessageResponse, error)

SendAction for a message.

func (*Channel) SendEvent 

func (ch *Channel) SendEvent(ctx context.Context, event *Event, userID string) (*Response, error)

SendEvent sends an event on this channel.

func (*Channel) SendFile 

func (ch *Channel) SendFile(ctx context.Context, request SendFileRequest) (*SendFileResponse, error)

SendFile sends file to the channel. Returns file url or error.

func (*Channel) SendImage 

func (ch *Channel) SendImage(ctx context.Context, request SendFileRequest) (*SendFileResponse, error)

SendFile sends image to the channel. Returns file url or error.

func (*Channel) SendMessage 

func (ch *Channel) SendMessage(ctx context.Context, message *Message, userID string, options ...SendMessageOption) (*MessageResponse, error)

SendMessage sends a message to the channel. Returns full message details from server.

func (*Channel) SendReaction 

func (ch *Channel) SendReaction(ctx context.Context, reaction *Reaction, messageID, userID string) (*ReactionResponse, error)

SendReaction sends a reaction to message with given ID. Deprecated: SendReaction is deprecated, use client.SendReaction instead.

func (*Channel) ShadowBan 

func (ch *Channel) ShadowBan(ctx context.Context, targetID, bannedByID string, options ...BanOption) (*Response, error)

ShadowBan shadow bans targetID on the channel ch.

func (*Channel) Show 

func (ch *Channel) Show(ctx context.Context, userID string) (*Response, error)

Show makes channel visible for userID.

func (*Channel) Truncate 

func (ch *Channel) Truncate(ctx context.Context, options ...TruncateOption) (*Response, error)

Truncate removes all messages from the channel. You can pass in options such as hard_delete, skip_push or a custom message.

func (*Channel) UnBanUser 

func (ch *Channel) UnBanUser(ctx context.Context, targetID string) (*Response, error)

UnBanUser removes the ban for targetID from the channel ch.

func (*Channel) UnmarshalJSON 

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

UnmarshalJSON implements json.Unmarshaler.

func (*Channel) Unmute 

func (ch *Channel) Unmute(ctx context.Context, userID string) (*Response, error)

Unmute removes a mute from a channel so the user will receive messages again.

func (*Channel) Update 

func (ch *Channel) Update(ctx context.Context, properties map[string]interface{}, message *Message) (*Response, error)

Update edits the channel's custom properties.

properties: the object to update the custom properties of this channel with message: optional update message

Example 
client := &Client{}
ctx := context.Background()

data := map[string]interface{}{
	"image":      "https://path/to/image",
	"created_by": "elon",
	"roles":      map[string]string{"elon": "admin", "gwynne": "moderator"},
}

spacexChannel := client.Channel("team", "spacex")
if _, err := spacexChannel.Update(ctx, data, nil); err != nil {
	log.Fatalf("Error: %v", err)
}

Output:

type ChannelConfig 

type ChannelConfig struct {
	Name string `json:"name"`

	// features
	// show typing indicators or not (probably auto disable if more than X users in a channel)
	TypingEvents bool `json:"typing_events"`
	// store who has read the message, or at least when they last viewed the chat
	ReadEvents bool `json:"read_events"`
	// connect events can get very noisy for larger chat groups
	ConnectEvents bool `json:"connect_events"`
	// make messages searchable
	Search    bool `json:"search"`
	Reactions bool `json:"reactions"`
	Reminders bool `json:"reminders"`
	Replies   bool `json:"replies"`
	Mutes     bool `json:"mutes"`
	// enable/disable push notifications
	PushNotifications bool `json:"push_notifications"`
	Uploads           bool `json:"uploads"`
	URLEnrichment     bool `json:"url_enrichment"`
	CustomEvents      bool `json:"custom_events"`

	// number of days to keep messages, must be MessageRetentionForever or numeric string
	MessageRetention string `json:"message_retention"`
	MaxMessageLength int    `json:"max_message_length"`

	Automod     modType      `json:"automod"` // disabled, simple or AI
	ModBehavior modBehaviour `json:"automod_behavior"`

	BlockList         string       `json:"blocklist"`
	BlockListBehavior modBehaviour `json:"blocklist_behavior"`
	AutomodThresholds *Thresholds  `json:"automod_thresholds"`
}

ChannelConfig is the configuration for a channel.

type ChannelMember 

type ChannelMember struct {
	UserID      string `json:"user_id,omitempty"`
	User        *User  `json:"user,omitempty"`
	IsModerator bool   `json:"is_moderator,omitempty"`

	Invited          bool       `json:"invited,omitempty"`
	InviteAcceptedAt *time.Time `json:"invite_accepted_at,omitempty"`
	InviteRejectedAt *time.Time `json:"invite_rejected_at,omitempty"`
	Role             string     `json:"role,omitempty"`

	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

type ChannelMute 

type ChannelMute struct {
	User      User       `json:"user"`
	Channel   Channel    `json:"channel"`
	Expires   *time.Time `json:"expires"`
	CreatedAt time.Time  `json:"created_at"`
	UpdatedAt time.Time  `json:"updated_at"`
}

ChannelMute represents a channel mute.

type ChannelMuteResponse 

type ChannelMuteResponse struct {
	ChannelMute ChannelMute `json:"channel_mute"`
	Response
}

type ChannelRead 

type ChannelRead struct {
	User     *User     `json:"user"`
	LastRead time.Time `json:"last_read"`
}

type ChannelRequest added in v5.1.0 

type ChannelRequest struct {
	CreatedBy               *User                  `json:"created_by,omitempty"`
	Team                    string                 `json:"team,omitempty"`
	AutoTranslationEnabled  bool                   `json:"auto_translation_enabled,omitempty"`
	AutoTranslationLanguage string                 `json:"auto_translation_language,omitempty"`
	Frozen                  *bool                  `json:"frozen,omitempty"`
	Disabled                *bool                  `json:"disabled,omitempty"`
	Members                 []string               `json:"members,omitempty"`
	Invites                 []string               `json:"invites,omitempty"`
	ExtraData               map[string]interface{} `json:"-"`
}

func (ChannelRequest) MarshalJSON added in v5.1.0 

func (c ChannelRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler.

func (*ChannelRequest) UnmarshalJSON added in v5.1.0 

func (c *ChannelRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler.

type ChannelType 

type ChannelType struct {
	ChannelConfig

	Commands []*Command `json:"commands"`
	// Deprecated: Use Permissions V2 API instead,
	// that can be found in permission_client.go.
	// See https://getstream.io/chat/docs/go-golang/migrating_from_legacy/?language=go
	Permissions []*ChannelTypePermission `json:"permissions"`
	Grants      map[string][]string      `json:"grants"`

	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

func NewChannelType 

func NewChannelType(name string) *ChannelType

NewChannelType returns initialized ChannelType with default values.

type ChannelTypePermission 

type ChannelTypePermission struct {
	Name   string `json:"name"`   // required
	Action string `json:"action"` // one of: Deny Allow

	Resources []string `json:"resources"` // required
	Roles     []string `json:"roles"`
	Owner     bool     `json:"owner"`
	Priority  int      `json:"priority"` // required
}

type ChannelTypeResponse 

type ChannelTypeResponse struct {
	*ChannelType

	Commands []string `json:"commands"`

	CreatedAt time.Time `json:"-"`
	UpdatedAt time.Time `json:"-"`

	Response
}

type ChannelTypesResponse 

type ChannelTypesResponse struct {
	ChannelTypes map[string]*ChannelType `json:"channel_types"`
	Response
}

type CheckPushRequest 

type CheckPushRequest struct {
	MessageID            string `json:"message_id,omitempty"`
	ApnTemplate          string `json:"apn_template,omitempty"`
	FirebaseTemplate     string `json:"firebase_template,omitempty"`
	FirebaseDataTemplate string `json:"firebase_data_template,omitempty"`
	SkipDevices          *bool  `json:"skip_devices,omitempty"`
	PushProviderName     string `json:"push_provider_name,omitempty"`
	PushProviderType     string `json:"push_provider_type,omitempty"`
	UserID               string `json:"user_id,omitempty"`
	User                 *User  `json:"user,omitempty"`
}

type CheckPushResponse 

type CheckPushResponse struct {
	DeviceErrors             map[string]DeviceError `json:"device_errors"`
	GeneralErrors            []string               `json:"general_errors"`
	SkipDevices              *bool                  `json:"skip_devices"`
	RenderedApnTemplate      string                 `json:"rendered_apn_template"`
	RenderedFirebaseTemplate string                 `json:"rendered_firebase_template"`
	RenderedMessage          map[string]string      `json:"rendered_message"`
	Response
}

type CheckSQSRequest 

type CheckSQSRequest struct {
	SqsURL    string `json:"sqs_url"`
	SqsKey    string `json:"sqs_key"`
	SqsSecret string `json:"sqs_secret"`
}

type CheckSQSResponse 

type CheckSQSResponse struct {
	Status string                 `json:"status"`
	Error  string                 `json:"error"`
	Data   map[string]interface{} `json:"data"`
	Response
}

type Client 

type Client struct {
	BaseURL string
	HTTP    *http.Client `json:"-"`
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(apiKey, apiSecret string, options ...ClientOption) (*Client, error)

NewClient creates new stream chat api client.

func NewClientFromEnvVars 

func NewClientFromEnvVars() (*Client, error)

NewClientFromEnvVars creates a new Client where the API key is retrieved from STREAM_KEY and the secret from STREAM_SECRET environmental variables.

func (*Client) AddDevice 

func (c *Client) AddDevice(ctx context.Context, device *Device) (*Response, error)

AddDevice adds new device.

Example 
client, _ := NewClient("XXXX", "XXXX")
ctx := context.Background()

_, _ = client.AddDevice(ctx, &Device{
	ID:           "2ffca4ad6599adc9b5202d15a5286d33c19547d472cd09de44219cda5ac30207",
	UserID:       "elon",
	PushProvider: PushProviderAPNS,
})

Output:

func (*Client) BanUser 

func (c *Client) BanUser(ctx context.Context, targetID, bannedBy string, options ...BanOption) (*Response, error)

BanUser bans targetID.

Example 
client, _ := NewClient("XXXX", "XXXX")
ctx := context.Background()

// ban a user for 60 minutes from all channel
_, _ = client.BanUser(ctx, "eviluser", "modUser", BanWithExpiration(60), BanWithReason("Banned for one hour"))

// ban a user from the livestream:fortnite channel
channel := client.Channel("livestream", "fortnite")
_, _ = channel.BanUser(ctx, "eviluser", "modUser", BanWithReason("Profanity is not allowed here"))

// remove ban from channel
channel = client.Channel("livestream", "fortnite")
_, _ = channel.UnBanUser(ctx, "eviluser")

// remove global ban
_, _ = client.UnBanUser(ctx, "eviluser")

Output:

func (*Client) Channel 

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

Channel returns a Channel object for future API calls.

func (*Client) CheckPush 

func (c *Client) CheckPush(ctx context.Context, req *CheckPushRequest) (*CheckPushResponse, error)

CheckPush initiates a push test.

func (*Client) CheckSqs 

func (c *Client) CheckSqs(ctx context.Context, req *CheckSQSRequest) (*CheckSQSResponse, error)

CheckSqs checks whether the AWS credentials are valid for the SQS queue access.

func (*Client) CreateBlocklist 

func (c *Client) CreateBlocklist(ctx context.Context, blocklist *BlocklistCreateRequest) (*Response, error)

CreateBlocklist creates a blocklist.

func (*Client) CreateChannel 

func (c *Client) CreateChannel(ctx context.Context, chanType, chanID, userID string, data *ChannelRequest) (*CreateChannelResponse, error)

CreateChannel creates new channel of given type and id or returns already created one.

func (*Client) CreateChannelType 

func (c *Client) CreateChannelType(ctx context.Context, chType *ChannelType) (*ChannelTypeResponse, error)

CreateChannelType adds new channel type.

Example

See https://getstream.io/chat/docs/channel_features/ for more details. 

client := &Client{}
ctx := context.Background()

newChannelType := &ChannelType{
	// Copy the default settings.
	ChannelConfig: DefaultChannelConfig,
}

newChannelType.Name = "public"
newChannelType.Mutes = false
newChannelType.Reactions = false
newChannelType.Permissions = append(newChannelType.Permissions,
	&ChannelTypePermission{
		Name:      "Allow reads for all",
		Priority:  999,
		Resources: []string{"ReadChannel", "CreateMessage"},
		Action:    "Allow",
	},
	&ChannelTypePermission{
		Name:      "Deny all",
		Priority:  1,
		Resources: []string{"*"},
		Action:    "Deny",
	},
)

_, _ = client.CreateChannelType(ctx, newChannelType)

Output:

func (*Client) CreateChannelWithMembers added in v5.1.0 

func (c *Client) CreateChannelWithMembers(ctx context.Context, chanType, chanID, userID string, memberIDs ...string) (*CreateChannelResponse, error)

CreateChannelWithMembers creates new channel of given type and id or returns already created one.

func (*Client) CreateCommand 

func (c *Client) CreateCommand(ctx context.Context, cmd *Command) (*CommandResponse, error)

CreateCommand registers a new custom command.

Example

See https://getstream.io/chat/docs/custom_commands/ for more details. 

client := &Client{}
ctx := context.Background()

newCommand := &Command{
	Name:        "my-command",
	Description: "my command",
	Args:        "[@username]",
	Set:         "custom_cmd_set",
}

_, _ = client.CreateCommand(ctx, newCommand)

Output:

func (*Client) CreateGuestUser 

func (c *Client) CreateGuestUser(ctx context.Context, user *User) (*GuestUserResponse, error)

CreateGuestUser creates a new guest user.

func (*Client) CreateImport 

func (c *Client) CreateImport(ctx context.Context, filePath string, mode ImportMode) (*CreateImportResponse, error)

CreateImport creates a new import task. Note: Do not use this. It is present for internal usage only. This function can, and will, break and/or be removed at any point in time.

func (*Client) CreateImportURL added in v5.4.0 

func (c *Client) CreateImportURL(ctx context.Context, filename string) (*CreateImportURLResponse, error)

CreateImportURL creates a new import URL. Note: Do not use this. It is present for internal usage only. This function can, and will, break and/or be removed at any point in time.

func (*Client) CreateToken 

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

CreateToken creates a new token for user with optional expire time. Zero time is assumed to be no expire.

func (*Client) DeactivateUser 

func (c *Client) DeactivateUser(ctx context.Context, targetID string, options ...DeactivateUserOptions) (*Response, error)

DeactivateUser deactivates the user with the given target user ID.

Example 
client, _ := NewClient("XXXX", "XXXX")
ctx := context.Background()

_, _ = client.DeactivateUser(ctx, "userID")

Output:

func (*Client) DeleteBlocklist 

func (c *Client) DeleteBlocklist(ctx context.Context, name string) (*Response, error)

DeleteBlocklist deletes a blocklist.

func (*Client) DeleteChannelType 

func (c *Client) DeleteChannelType(ctx context.Context, name string) (*Response, error)

DeleteChannelType deletes channel type.

Example 
client := &Client{}
ctx := context.Background()

_, _ = client.DeleteChannelType(ctx, "public")

Output:

func (*Client) DeleteChannels 

func (c *Client) DeleteChannels(ctx context.Context, cids []string, hardDelete bool) (*AsyncTaskResponse, error)

DeleteChannels deletes channels asynchronously. Channels and messages will be hard deleted if hardDelete is true. It returns an AsyncTaskResponse object which contains the task ID, the status of the task can be check with client.GetTask method.

func (*Client) DeleteCommand 

func (c *Client) DeleteCommand(ctx context.Context, cmdName string) (*Response, error)

DeleteCommand deletes a custom command referenced by cmdName.

Example 
client := &Client{}
ctx := context.Background()

_, _ = client.DeleteCommand(ctx, "my-command")

Output:

func (*Client) DeleteDevice 

func (c *Client) DeleteDevice(ctx context.Context, userID, deviceID string) (*Response, error)

DeleteDevice deletes a device from the user.

Example 
client, _ := NewClient("XXXX", "XXXX")
ctx := context.Background()

deviceID := "2ffca4ad6599adc9b5202d15a5286d33c19547d472cd09de44219cda5ac30207"
userID := "elon"
_, _ = client.DeleteDevice(ctx, userID, deviceID)

Output:

func (*Client) DeleteMessage 

func (c *Client) DeleteMessage(ctx context.Context, msgID string) (*Response, error)

DeleteMessage soft deletes the message with given msgID.

func (*Client) DeletePushProvider added in v5.7.0 

func (c *Client) DeletePushProvider(ctx context.Context, providerType, name string) (*Response, error)

DeletePushProvider deletes a push provider.

func (*Client) DeleteReaction added in v5.8.0 

func (c *Client) DeleteReaction(ctx context.Context, messageID, reactionType, userID string) (*ReactionResponse, error)

DeleteReaction removes a reaction from message with given ID.

func (*Client) DeleteUser 

func (c *Client) DeleteUser(ctx context.Context, targetID string, options ...DeleteUserOption) (*Response, error)

DeleteUser deletes the user with the given target user ID.

Example 
client, _ := NewClient("XXXX", "XXXX")
ctx := context.Background()

_, _ = client.DeleteUser(ctx, "userID")

Output:
Example (Hard) 
client, _ := NewClient("XXXX", "XXXX")
ctx := context.Background()

_, _ = client.DeleteUser(ctx, "userID",
	DeleteUserWithHardDelete(),
	DeleteUserWithMarkMessagesDeleted(),
)

Output:

func (*Client) DeleteUsers 

func (c *Client) DeleteUsers(ctx context.Context, userIDs []string, options DeleteUserOptions) (*AsyncTaskResponse, error)

DeleteUsers deletes users asynchronously. User will be deleted either "hard" or "soft" Conversations (1to1 channels) will be deleted if either "hard" or "soft" Messages will be deleted if either "hard" or "soft" NewChannelOwnerID any channels owned by the hard-deleted user will be transferred to this user ID It returns an AsyncTaskResponse object which contains the task ID, the status of the task can be check with client.GetTask method.

func (*Client) ExportChannels 

func (c *Client) ExportChannels(ctx context.Context, channels []*ExportableChannel, options *ExportChannelOptions) (*AsyncTaskResponse, error)

ExportChannels requests an asynchronous export of the provided channels. It returns an AsyncTaskResponse object which contains the task ID, the status of the task can be check with client.GetTask method.

func (*Client) ExportUser 

func (c *Client) ExportUser(ctx context.Context, targetID string) (*ExportUserResponse, error)

ExportUser exports the user with the given target user ID.

Example 
client, _ := NewClient("XXXX", "XXXX")
ctx := context.Background()

user, _ := client.ExportUser(ctx, "userID")
log.Printf("%#v", user)

Output:

func (*Client) FlagMessage 

func (c *Client) FlagMessage(ctx context.Context, msgID, userID string) (*Response, error)

FlagMessage flags the message with given msgID.

func (*Client) FlagUser 

func (c *Client) FlagUser(ctx context.Context, targetID, flaggedBy string) (*Response, error)

FlagUser flags the user with the given targetID.

func (*Client) GetAppConfig 

func (c *Client) GetAppConfig(ctx context.Context) (*AppResponse, error)

GetAppConfig returns app settings.

func (*Client) GetBlocklist 

func (c *Client) GetBlocklist(ctx context.Context, name string) (*GetBlocklistResponse, error)

GetBlocklist gets a blocklist.

func (*Client) GetChannelType 

func (c *Client) GetChannelType(ctx context.Context, chanType string) (*GetChannelTypeResponse, error)

GetChannelType returns information about channel type.

Example 
client := &Client{}
ctx := context.Background()
_, _ = client.GetChannelType(ctx, "public")

Output:

func (*Client) GetCommand 

func (c *Client) GetCommand(ctx context.Context, cmdName string) (*GetCommandResponse, error)

GetCommand retrieves a custom command referenced by cmdName.

Example 
client := &Client{}
ctx := context.Background()
_, _ = client.GetCommand(ctx, "my-command")

Output:

func (*Client) GetDevices 

func (c *Client) GetDevices(ctx context.Context, userID string) (*DevicesResponse, error)

GetDevices retrieves the list of devices for user.

func (*Client) GetExportChannelsTask 

func (c *Client) GetExportChannelsTask(ctx context.Context, taskID string) (*TaskResponse, error)

GetExportChannelsTask returns current state of the export task.

func (*Client) GetImport 

func (c *Client) GetImport(ctx context.Context, id string) (*GetImportResponse, error)

GetImport returns an import task. Note: Do not use this. It is present for internal usage only. This function can, and will, break and/or be removed at any point in time.

func (*Client) GetMessage 

func (c *Client) GetMessage(ctx context.Context, msgID string) (*MessageResponse, error)

GetMessage returns message by ID.

func (*Client) GetRateLimits 

func (c *Client) GetRateLimits(ctx context.Context, options ...GetRateLimitsOption) (GetRateLimitsResponse, error)

GetRateLimits returns the current rate limit quotas and usage. If no options are passed, all the limits for all platforms are returned.

func (*Client) GetReactions added in v5.8.0 

func (c *Client) GetReactions(ctx context.Context, messageID string, options map[string][]string) (*ReactionsResponse, error)

GetReactions returns list of the reactions for message with given ID. options: Pagination params, ie {"limit":{"10"}, "idlte": {"10"}}

func (*Client) GetTask 

func (c *Client) GetTask(ctx context.Context, id string) (*TaskResponse, error)

GetTask returns the status of a task that has been ran asynchronously.

func (*Client) HardDeleteMessage 

func (c *Client) HardDeleteMessage(ctx context.Context, msgID string) (*Response, error)

HardDeleteMessage deletes the message with given msgID. This is permanent.

func (*Client) ListBlocklists 

func (c *Client) ListBlocklists(ctx context.Context) (*ListBlocklistsResponse, error)

ListBlocklists lists all blocklists.

func (*Client) ListChannelTypes 

func (c *Client) ListChannelTypes(ctx context.Context) (*ChannelTypesResponse, error)

ListChannelTypes returns all channel types.

Example 
client := &Client{}
ctx := context.Background()
_, _ = client.ListChannelTypes(ctx)

Output:

func (*Client) ListCommands 

func (c *Client) ListCommands(ctx context.Context) (*CommandsResponse, error)

ListCommands returns a list of custom commands.

Example 
client := &Client{}
ctx := context.Background()
_, _ = client.ListCommands(ctx)

Output:

func (*Client) ListImports 

func (c *Client) ListImports(ctx context.Context, opts *ListImportsOptions) (*ListImportsResponse, error)

ListImports returns all import tasks. Note: Do not use this. It is present for internal usage only. This function can, and will, break and/or be removed at any point in time.

func (*Client) ListPushProviders added in v5.7.0 

func (c *Client) ListPushProviders(ctx context.Context) (*PushProviderListResponse, error)

ListPushProviders returns the list of push providers.

func (*Client) MarkAllRead 

func (c *Client) MarkAllRead(ctx context.Context, userID string) (*Response, error)

MarkAllRead marks all messages as read for userID.

func (*Client) MuteUser 

func (c *Client) MuteUser(ctx context.Context, targetID, mutedBy string, options ...MuteOption) (*Response, error)

MuteUser mutes targetID.

func (*Client) MuteUsers 

func (c *Client) MuteUsers(ctx context.Context, targetIDs []string, mutedBy string, options ...MuteOption) (*Response, error)

MuteUsers mutes all users in targetIDs.

func (*Client) PartialUpdateMessage 

func (c *Client) PartialUpdateMessage(ctx context.Context, messageID string, updates *MessagePartialUpdateRequest) (*MessageResponse, error)

PartialUpdateMessage partially updates message with given msgID.

func (*Client) PartialUpdateUser 

func (c *Client) PartialUpdateUser(ctx context.Context, update PartialUserUpdate) (*User, error)

PartialUpdateUser makes partial update for single user.

func (*Client) PartialUpdateUsers 

func (c *Client) PartialUpdateUsers(ctx context.Context, updates []PartialUserUpdate) (*UsersResponse, error)

PartialUpdateUsers makes partial update for users.

func (*Client) Permissions 

func (c *Client) Permissions() *PermissionClient

Permissions returns a client for handling app permissions.

func (*Client) PinMessage 

func (c *Client) PinMessage(ctx context.Context, msgID, pinnedByID string, expiration *time.Time) (*MessageResponse, error)

PinMessage pins the message with given msgID.

func (*Client) QueryBannedUsers 

func (c *Client) QueryBannedUsers(ctx context.Context, q *QueryBannedUsersOptions, sorters ...*SortOption) (*QueryBannedUsersResponse, error)

QueryBannedUsers filters and returns a list of banned users. Banned users can be retrieved in different ways: 1) Using the dedicated query bans endpoint 2) User Search: you can add the banned:true condition to your search. Please note that this will only return users that were banned at the app-level and not the ones that were banned only on channels.

func (*Client) QueryChannels 

func (c *Client) QueryChannels(ctx context.Context, q *QueryOption, sort ...*SortOption) (*QueryChannelsResponse, error)

QueryChannels returns list of channels with members and messages, that match QueryOption. If any number of SortOption are set, result will be sorted by field and direction in oder of sort options.

func (*Client) QueryFlagReports added in v5.7.0 

func (c *Client) QueryFlagReports(ctx context.Context, q *QueryFlagReportsRequest) (*QueryFlagReportsResponse, error)

QueryFlagReports returns list of flag reports that match the filter.

func (*Client) QueryMessageFlags 

func (c *Client) QueryMessageFlags(ctx context.Context, q *QueryOption) (*QueryMessageFlagsResponse, error)

QueryMessageFlags returns list of message flags that match QueryOption.

func (*Client) QueryUsers 

func (c *Client) QueryUsers(ctx context.Context, q *QueryOption, sorters ...*SortOption) (*QueryUsersResponse, error)

QueryUsers returns list of users that match QueryOption. If any number of SortOption are set, result will be sorted by field and direction in the order of sort options.

func (*Client) ReactivateUser 

func (c *Client) ReactivateUser(ctx context.Context, targetID string, options ...ReactivateUserOptions) (*Response, error)

ReactivateUser reactivates a deactivated user with the given target user ID.

Example 
client, _ := NewClient("XXXX", "XXXX")
ctx := context.Background()

_, _ = client.ReactivateUser(ctx, "userID")

Output:

func (*Client) ReviewFlagReport added in v5.7.0 

func (c *Client) ReviewFlagReport(ctx context.Context, reportID string, req *ReviewFlagReportRequest) (*ReviewFlagReportResponse, error)

ReviewFlagReports sends a review of the flag report ID.

func (*Client) RevokeTokens 

func (c *Client) RevokeTokens(ctx context.Context, before *time.Time) (*Response, error)

RevokeTokens revokes all tokens for an application issued before given time.

func (*Client) RevokeUserToken 

func (c *Client) RevokeUserToken(ctx context.Context, userID string, before *time.Time) (*Response, error)

RevokeUserToken revoke token for a user issued before given time.

func (*Client) RevokeUsersTokens 

func (c *Client) RevokeUsersTokens(ctx context.Context, userIDs []string, before *time.Time) (*Response, error)

RevokeUsersTokens revoke tokens for users issued before given time.

func (*Client) Search 

func (c *Client) Search(ctx context.Context, request SearchRequest) (*SearchResponse, error)

Search returns messages matching for given keyword.

func (*Client) SearchWithFullResponse 

func (c *Client) SearchWithFullResponse(ctx context.Context, request SearchRequest) (*SearchFullResponse, error)

SearchWithFullResponse performs a search and returns the full results.

func (*Client) SendReaction added in v5.8.0 

func (c *Client) SendReaction(ctx context.Context, reaction *Reaction, messageID, userID string) (*ReactionResponse, error)

SendReaction sends a reaction to message with given ID.

Example 
client := &Client{}
msgID := "123"
userID := "bob-1"
ctx := context.Background()

reaction := &Reaction{
	Type:      "love",
	ExtraData: map[string]interface{}{"my_custom_field": 123},
}
_, err := client.SendReaction(ctx, reaction, msgID, userID)
if err != nil {
	log.Fatalf("Found Error: %v", err)
}

Output:

func (*Client) SendUserCustomEvent 

func (c *Client) SendUserCustomEvent(ctx context.Context, targetUserID string, event *UserCustomEvent) (*Response, error)

SendUserCustomEvent sends a custom event to all connected clients for the target user id.

func (*Client) SetClient 

func (c *Client) SetClient(client *http.Client)

SetClient sets a new underlying HTTP client.

func (*Client) ShadowBan 

func (c *Client) ShadowBan(ctx context.Context, targetID, bannedByID string, options ...BanOption) (*Response, error)

ShadowBan shadow bans targetID.

func (*Client) TranslateMessage added in v5.1.0 

func (c *Client) TranslateMessage(ctx context.Context, msgID, language string) (*TranslationResponse, error)

TranslateMessage translates the message with given msgID to the given language.

func (*Client) UnBanUser 

func (c *Client) UnBanUser(ctx context.Context, targetID string) (*Response, error)

UnBanUser removes the ban for targetID.

func (*Client) UnPinMessage 

func (c *Client) UnPinMessage(ctx context.Context, msgID, userID string) (*MessageResponse, error)

UnPinMessage unpins the message with given msgID.

func (*Client) UnmuteUser 

func (c *Client) UnmuteUser(ctx context.Context, targetID, unmutedBy string) (*Response, error)

UnmuteUser unmute targetID.

func (*Client) UnmuteUsers 

func (c *Client) UnmuteUsers(ctx context.Context, targetIDs []string, unmutedBy string) (*Response, error)

UnmuteUsers unmute all users in targetIDs.

func (*Client) UpdateAppSettings 

func (c *Client) UpdateAppSettings(ctx context.Context, settings *AppSettings) (*Response, error)

UpdateAppSettings makes request to update app settings Example of usage: 

settings := NewAppSettings().SetDisableAuth(true)
err := client.UpdateAppSettings(settings)
Example (Disable_auth)

See https://getstream.io/chat/docs/app_settings_auth/ for more details. 

client, err := NewClient("XXXXXXXXXXXX", "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
if err != nil {
	log.Fatalf("Err: %v", err)
}
ctx := context.Background()

// disable auth checks, allows dev token usage
settings := NewAppSettings().SetDisableAuth(true)
_, err = client.UpdateAppSettings(ctx, settings)
if err != nil {
	log.Fatalf("Err: %v", err)
}

// re-enable auth checks
_, err = client.UpdateAppSettings(ctx, NewAppSettings().SetDisableAuth(false))
if err != nil {
	log.Fatalf("Err: %v", err)
}

Output:
Example (Disable_permission) 
client, err := NewClient("XXXX", "XXXX")
if err != nil {
	log.Fatalf("Err: %v", err)
}
ctx := context.Background()

// disable permission checkse
settings := NewAppSettings().SetDisablePermissions(true)
_, err = client.UpdateAppSettings(ctx, settings)
if err != nil {
	log.Fatalf("Err: %v", err)
}

// re-enable permission checks
_, err = client.UpdateAppSettings(ctx, NewAppSettings().SetDisablePermissions(false))
if err != nil {
	log.Fatalf("Err: %v", err)
}

Output:

func (*Client) UpdateBlocklist 

func (c *Client) UpdateBlocklist(ctx context.Context, name string, words []string) (*Response, error)

UpdateBlocklist updates a blocklist.

func (*Client) UpdateChannelType 

func (c *Client) UpdateChannelType(ctx context.Context, name string, options map[string]interface{}) (*Response, error)

UpdateChannelType updates channel type.

Example 
client := &Client{}
ctx := context.Background()

_, _ = client.UpdateChannelType(ctx, "public", map[string]interface{}{
	"permissions": []map[string]interface{}{
		{
			"name":      "Allow reads for all",
			"priority":  999,
			"resources": []string{"ReadChannel", "CreateMessage"},
			"role":      "*",
			"action":    "Allow",
		},
		{
			"name":      "Deny all",
			"priority":  1,
			"resources": []string{"*"},
			"role":      "*",
			"action":    "Deny",
		},
	},
	"replies":  false,
	"commands": []string{"all"},
})

Output:
Example (Bool) 
client := &Client{}
ctx := context.Background()

_, _ = client.UpdateChannelType(ctx, "public", map[string]interface{}{
	"typing_events":  false,
	"read_events":    true,
	"connect_events": true,
	"search":         false,
	"reactions":      true,
	"replies":        false,
	"mutes":          true,
})

Output:
Example (Other) 
client := &Client{}
ctx := context.Background()

_, _ = client.UpdateChannelType(ctx,
	"public",
	map[string]interface{}{
		"automod":            "disabled",
		"message_retention":  "7",
		"max_message_length": 140,
		"commands":           []interface{}{"ban", "unban"},
	},
)

Output:
Example (Permissions) 
client := &Client{}
ctx := context.Background()

_, _ = client.UpdateChannelType(ctx,
	"public",
	map[string]interface{}{
		"permissions": []map[string]interface{}{
			{
				"name":      "Allow reads for all",
				"priority":  999,
				"resources": []string{"ReadChannel", "CreateMessage"},
				"role":      "*",
				"action":    "Allow",
			},
			{
				"name":      "Deny all",
				"priority":  1,
				"resources": []string{"*"},
				"action":    "Deny",
			},
		},
	},
)

Output:

func (*Client) UpdateCommand 

func (c *Client) UpdateCommand(ctx context.Context, cmdName string, update *Command) (*CommandResponse, error)

UpdateCommand updates a custom command referenced by cmdName.

Example 
client := &Client{}
ctx := context.Background()

update := Command{Description: "updated description"}
_, _ = client.UpdateCommand(ctx, "my-command", &update)

Output:

func (*Client) UpdateMessage 

func (c *Client) UpdateMessage(ctx context.Context, msg *Message, msgID string) (*MessageResponse, error)

UpdateMessage updates message with given msgID.

func (*Client) UpsertPushProvider added in v5.7.0 

func (c *Client) UpsertPushProvider(ctx context.Context, provider *PushProvider) (*Response, error)

UpsertPushProvider inserts or updates a push provider.

func (*Client) UpsertUser 

func (c *Client) UpsertUser(ctx context.Context, user *User) (*UpsertUserResponse, error)

UpsertUser is a single user version of UpsertUsers for convenience.

Example 
client, _ := NewClient("XXXX", "XXXX")
ctx := context.Background()

_, err := client.UpsertUser(ctx, &User{
	ID:   "tommaso",
	Name: "Tommaso",
	Role: "Admin",
})
if err != nil {
	log.Fatalf("Err: %v", err)
}

Output:

func (*Client) UpsertUsers 

func (c *Client) UpsertUsers(ctx context.Context, users ...*User) (*UsersResponse, error)

UpsertUsers creates the given users. If a user doesn't exist, it will be created. Otherwise, custom data will be extended or updated. Missing data is never removed.

func (*Client) VerifyWebhook 

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

VerifyWebhook validates if hmac signature is correct for message body.

type ClientOption added in v5.7.0 

type ClientOption func(c *Client)

type Command 

type Command struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Args        string `json:"args"`
	Set         string `json:"set"`
}

Command represents a custom command.

type CommandResponse 

type CommandResponse struct {
	Command *Command `json:"command"`
	Response
}

CommandResponse represents an API response containing one Command.

type CommandsResponse 

type CommandsResponse struct {
	Commands []*Command
}

CommandsResponse represents an API response containing a list of Command.

type CreateChannelResponse 

type CreateChannelResponse struct {
	Channel *Channel
	*Response
}

type CreateImportResponse 

type CreateImportResponse struct {
	ImportTask *ImportTask `json:"import_task"`
	Response
}

type CreateImportURLResponse added in v5.4.0 

type CreateImportURLResponse struct {
	Path      string `json:"path"`
	UploadURL string `json:"upload_url"`
	Response
}

type DeactivateUserOptions 

type DeactivateUserOptions func(*deactivateUserOptions)

type DeleteType 

type DeleteType string
const (
	HardDelete DeleteType = "hard"
	SoftDelete DeleteType = "soft"
)

type DeleteUserOption 

type DeleteUserOption func(*deleteUserOptions)

type DeleteUserOptions 

type DeleteUserOptions struct {
	User              DeleteType `json:"user"`
	Messages          DeleteType `json:"messages,omitempty"`
	Conversations     DeleteType `json:"conversations,omitempty"`
	NewChannelOwnerID string     `json:"new_channel_owner_id,omitempty"`
}

type Device 

type Device struct {
	ID               string           `json:"id"`                 // The device ID.
	UserID           string           `json:"user_id"`            // The user ID for this device.
	PushProvider     PushProviderType `json:"push_provider"`      // The push provider for this device. One of constants PushProvider*
	PushProviderName string           `json:"push_provider_name"` // The push provider name for this device.
}

type DeviceError 

type DeviceError struct {
	Provider     string `json:"provider"`
	ProviderName string `json:"provider_name"`
	ErrorMessage string `json:"error_message"`
}

type DevicesResponse 

type DevicesResponse struct {
	Devices []*Device `json:"devices"`
	Response
}

type Error 

type Error struct {
	Code            int               `json:"code"`
	Message         string            `json:"message"`
	ExceptionFields map[string]string `json:"exception_fields,omitempty"`
	StatusCode      int               `json:"StatusCode"`
	Duration        string            `json:"duration"`
	MoreInfo        string            `json:"more_info"`

	RateLimit *RateLimitInfo `json:"-"`
}

func (Error) Error 

func (e Error) Error() string

type Event 

type Event struct {
	CID          string           `json:"cid,omitempty"` // Channel ID
	Type         EventType        `json:"type"`          // Event type, one of Event* constants
	Message      *Message         `json:"message,omitempty"`
	Reaction     *Reaction        `json:"reaction,omitempty"`
	Channel      *Channel         `json:"channel,omitempty"`
	Member       *ChannelMember   `json:"member,omitempty"`
	Members      []*ChannelMember `json:"members,omitempty"`
	User         *User            `json:"user,omitempty"`
	UserID       string           `json:"user_id,omitempty"`
	OwnUser      *User            `json:"me,omitempty"`
	WatcherCount int              `json:"watcher_count,omitempty"`

	ExtraData map[string]interface{} `json:"-"`

	CreatedAt time.Time `json:"created_at,omitempty"`
}

Event is received from a webhook, or sent with the SendEvent function.

func (Event) MarshalJSON 

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

func (*Event) UnmarshalJSON 

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

type EventType 

type EventType string

EventType marks which of the various sub-types of a webhook event you are receiving or sending. 

const (
	// EventMessageNew is fired when a new message is added.
	EventMessageNew EventType = "message.new"
	// EventMessageUpdated is fired when a message is updated.
	EventMessageUpdated EventType = "message.updated"
	// EventMessageDeleted is fired when a message is deleted.
	EventMessageDeleted EventType = "message.deleted"
	// EventMessageRead is fired when a user calls mark as read.
	EventMessageRead EventType = "message.read"

	// EventReactionNew is fired when a message reaction is added.
	EventReactionNew EventType = "reaction.new"
	// EventReactionDeleted is fired when a message reaction deleted.
	EventReactionDeleted EventType = "reaction.deleted"

	// EventMemberAdded is fired when a member is added to a channel.
	EventMemberAdded EventType = "member.added"
	// EventMemberUpdated is fired when a member is updated.
	EventMemberUpdated EventType = "member.updated"
	// EventMemberRemoved is fired when a member is removed from a channel.
	EventMemberRemoved EventType = "member.removed"

	// EventChannelCreated is fired when a channel is created.
	EventChannelCreated EventType = "channel.created"
	// EventChannelUpdated is fired when a channel is updated.
	EventChannelUpdated EventType = "channel.updated"
	// EventChannelDeleted is fired when a channel is deleted.
	EventChannelDeleted EventType = "channel.deleted"
	// EventChannelTruncated is fired when a channel is truncated.
	EventChannelTruncated EventType = "channel.truncated"

	// EventHealthCheck is fired when a user is updated.
	EventHealthCheck EventType = "health.check"

	// EventNotificationNewMessage and family are fired when a notification is
	// created, marked read, invited to a channel, and so on.
	EventNotificationNewMessage         EventType = "notification.message_new"
	EventNotificationMarkRead           EventType = "notification.mark_read"
	EventNotificationInvited            EventType = "notification.invited"
	EventNotificationInviteAccepted     EventType = "notification.invite_accepted"
	EventNotificationAddedToChannel     EventType = "notification.added_to_channel"
	EventNotificationRemovedFromChannel EventType = "notification.removed_from_channel"
	EventNotificationMutesUpdated       EventType = "notification.mutes_updated"

	// EventTypingStart and EventTypingStop are fired when a user starts or stops typing.
	EventTypingStart EventType = "typing.start"
	EventTypingStop  EventType = "typing.stop"

	// EventUserMuted is fired when a user is muted.
	EventUserMuted EventType = "user.muted"
	// EventUserUnmuted is fired when a user is unmuted.
	EventUserUnmuted         EventType = "user.unmuted"
	EventUserPresenceChanged EventType = "user.presence.changed"
	EventUserWatchingStart   EventType = "user.watching.start"
	EventUserWatchingStop    EventType = "user.watching.stop"
	EventUserUpdated         EventType = "user.updated"
)

type ExportChannelOptions 

type ExportChannelOptions struct {
	ClearDeletedMessageText  *bool  `json:"clear_deleted_message_text,omitempty"`
	IncludeTruncatedMessages *bool  `json:"include_truncated_messages,omitempty"`
	ExportUsers              *bool  `json:"export_users,omitempty"`
	Version                  string `json:"version,omitempty"`
}

type ExportUserResponse 

type ExportUserResponse struct {
	*User
	Response
}

type ExportableChannel 

type ExportableChannel struct {
	Type          string     `json:"type"`
	ID            string     `json:"id"`
	MessagesSince *time.Time `json:"messages_since,omitempty"`
	MessagesUntil *time.Time `json:"messages_until,omitempty"`
}

type ExtendedFlagReport added in v5.7.0 

type ExtendedFlagReport struct {
	FlagReport
	ReviewResult  string                 `json:"review_result"`
	ReviewDetails map[string]interface{} `json:"review_details"`
	ReviewedAt    time.Time              `json:"reviewed_at"`
	ReviewedBy    User                   `json:"reviewed_by"`
}

type FileUploadConfig 

type FileUploadConfig struct {
	AllowedFileExtensions []string `json:"allowed_file_extensions,omitempty"`
	BlockedFileExtensions []string `json:"blocked_file_extensions,omitempty"`
	AllowedMimeTypes      []string `json:"allowed_mime_types,omitempty"`
	BlockedMimeTypes      []string `json:"blocked_mime_types,omitempty"`
}

type FirebaseConfig 

type FirebaseConfig struct {
	Enabled              bool   `json:"enabled"`
	NotificationTemplate string `json:"notification_template"`
	DataTemplate         string `json:"data_template"`
}

type FirebaseConfigRequest added in v5.1.0 

type FirebaseConfigRequest struct {
	ServerKey            string  `json:"server_key"`
	NotificationTemplate string  `json:"notification_template,omitempty"`
	DataTemplate         string  `json:"data_template,omitempty"`
	APNTemplate          *string `json:"apn_template,omitempty"`
	CredentialsJSON      string  `json:"credentials_json,omitempty"`
}

type FlagReport added in v5.7.0 

type FlagReport struct {
	ID            string    `json:"id"`
	Message       *Message  `json:"message"`
	FlagsCount    int       `json:"flags_count"`
	MessageUserID string    `json:"message_user_id"`
	ChannelCid    string    `json:"channel_cid"`
	CreatedAt     time.Time `json:"created_at"`
	UpdatedAt     time.Time `json:"updated_at"`
}

type GetBlocklistResponse 

type GetBlocklistResponse struct {
	Blocklist *Blocklist `json:"blocklist"`
	Response
}

type GetChannelTypeResponse 

type GetChannelTypeResponse struct {
	*ChannelType
	Response
}

type GetCommandResponse 

type GetCommandResponse struct {
	*Command
	Response
}

type GetImportResponse 

type GetImportResponse struct {
	ImportTask *ImportTask `json:"import_task"`
	Response
}

type GetMessagesResponse 

type GetMessagesResponse struct {
	Messages []*Message `json:"messages"`
	Response
}

type GetPermissionResponse 

type GetPermissionResponse struct {
	Permission *Permission `json:"permission"`
	Response
}

type GetRateLimitsOption 

type GetRateLimitsOption func(p *getRateLimitsParams)

GetRateLimitsOption configures the Client.GetRateLimits call.

func WithAndroid 

func WithAndroid() GetRateLimitsOption

WithAndroid restricts the returned limits to Android clients only.

func WithEndpoints 

func WithEndpoints(endpoints ...string) GetRateLimitsOption

WithEndpoints restricts the returned limits info to the specified endpoints.

func WithIOS 

func WithIOS() GetRateLimitsOption

WithIOS restricts the returned limits to iOS clients only.

func WithServerSide 

func WithServerSide() GetRateLimitsOption

WithServerSide restricts the returned limits to server-side clients only.

func WithWeb 

func WithWeb() GetRateLimitsOption

WithWeb restricts the returned limits to web clients only.

type GetRateLimitsResponse 

type GetRateLimitsResponse struct {
	ServerSide RateLimitsMap `json:"server_side,omitempty"`
	Android    RateLimitsMap `json:"android,omitempty"`
	IOS        RateLimitsMap `json:"ios,omitempty"`
	Web        RateLimitsMap `json:"web,omitempty"`
}

GetRateLimitsResponse is the response of the Client.GetRateLimits call. It includes, if present, the rate limits for the supported platforms, namely server-side, Android, iOS, and web.

type GuestUserResponse 

type GuestUserResponse struct {
	User        *User  `json:"user"`
	AccessToken string `json:"access_token"`
	Response
}

type HuaweiConfig added in v5.1.0 

type HuaweiConfig struct {
	Enabled bool `json:"enabled"`
}

type HuaweiConfigRequest added in v5.1.0 

type HuaweiConfigRequest struct {
	ID     string `json:"id"`
	Secret string `json:"secret"`
}

type ImportMode added in v5.6.0 

type ImportMode string
const (
	InsertMode ImportMode = "insert"
	UpsertMode ImportMode = "upsert"
)

type ImportTask 

type ImportTask struct {
	CreatedAt time.Time            `json:"created_at"`
	Path      string               `json:"path"`
	Mode      ImportMode           `json:"mode"`
	History   []*ImportTaskHistory `json:"history"`
	ID        string               `json:"id"`
	State     string               `json:"state"`
	UpdatedAt time.Time            `json:"updated_at"`
	Result    interface{}          `json:"result"`
	Size      *int                 `json:"size"`
}

type ImportTaskHistory 

type ImportTaskHistory struct {
	CreatedAt time.Time `json:"created_at"`
	NextState string    `json:"next_state"`
	PrevState string    `json:"prev_state"`
}

type LabelThresholds 

type LabelThresholds struct {
	Flag  float32 `json:"flag"`
	Block float32 `json:"block"`
}

type ListBlocklistsResponse 

type ListBlocklistsResponse struct {
	Blocklists []*Blocklist `json:"blocklists"`
	Response
}

type ListImportsOptions 

type ListImportsOptions struct {
	Limit  int
	Offset int
}

type ListImportsResponse 

type ListImportsResponse struct {
	ImportTasks []*ImportTask `json:"import_tasks"`
	Response
}

type ListPermissionsResponse 

type ListPermissionsResponse struct {
	Permissions []*Permission `json:"permissions"`
	Response
}

type MarkReadOption 

type MarkReadOption func(*markReadOption)

type Message 

type Message struct {
	ID  string `json:"id"`
	CID string `json:"cid"`

	Text string `json:"text"`
	HTML string `json:"html"`

	Type   MessageType `json:"type,omitempty"` // one of MessageType* constants
	Silent bool        `json:"silent,omitempty"`

	User            *User          `json:"user"`
	Attachments     []*Attachment  `json:"attachments"`
	LatestReactions []*Reaction    `json:"latest_reactions"` // last reactions
	OwnReactions    []*Reaction    `json:"own_reactions"`
	ReactionCounts  map[string]int `json:"reaction_counts"`
	ReactionScores  map[string]int `json:"reaction_scores"`

	ParentID           string  `json:"parent_id,omitempty"`       // id of parent message if it's reply
	ShowInChannel      bool    `json:"show_in_channel,omitempty"` // show reply message also in channel
	ThreadParticipants []*User `json:"thread_participants,omitempty"`

	ReplyCount      int     `json:"reply_count,omitempty"`
	QuotedMessageID string  `json:"quoted_message_id,omitempty"`
	MentionedUsers  []*User `json:"mentioned_users"`

	Command string `json:"command,omitempty"`

	Shadowed   bool       `json:"shadowed,omitempty"`
	Pinned     bool       `json:"pinned,omitempty"`
	PinnedAt   *time.Time `json:"pinned_at,omitempty"`
	PinnedBy   *User      `json:"pinned_by,omitempty"`
	PinExpires *time.Time `json:"pin_expires,omitempty"`

	ImageModerationLabels map[string][]string `json:"image_labels,omitempty"`

	MML  string            `json:"mml,omitempty"`
	I18n map[string]string `json:"i18n,omitempty"`

	CreatedAt *time.Time `json:"created_at,omitempty"`
	UpdatedAt *time.Time `json:"updated_at,omitempty"`
	DeletedAt *time.Time `json:"deleted_at,omitempty"`

	ExtraData map[string]interface{} `json:"-"`
}

func (Message) MarshalJSON 

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

MarshalJSON implements json.Marshaler.

func (*Message) UnmarshalJSON 

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

UnmarshalJSON implements json.Unmarshaler.

type MessageFlag 

type MessageFlag struct {
	CreatedByAutomod bool `json:"created_by_automod"`
	ModerationResult *struct {
		MessageID            string `json:"message_id"`
		Action               string `json:"action"`
		ModeratedBy          string `json:"moderated_by"`
		BlockedWord          string `json:"blocked_word"`
		BlocklistName        string `json:"blocklist_name"`
		ModerationThresholds *struct {
			Explicit *struct {
				Flag  float32 `json:"flag"`
				Block float32 `json:"block"`
			} `json:"explicit"`
			Spam *struct {
				Flag  float32 `json:"flag"`
				Block float32 `json:"block"`
			} `json:"spam"`
			Toxic *struct {
				Flag  float32 `json:"flag"`
				Block float32 `json:"block"`
			} `json:"toxic"`
		} `json:"moderation_thresholds"`
		AIModerationResponse *struct {
			Toxic    float32 `json:"toxic"`
			Explicit float32 `json:"explicit"`
			Spam     float32 `json:"spam"`
		} `json:"ai_moderation_response"`
		UserKarma    float64   `json:"user_karma"`
		UserBadKarma bool      `json:"user_bad_karma"`
		CreatedAt    time.Time `json:"created_at"`
		UpdatedAt    time.Time `json:"updated_at"`
	} `json:"moderation_result"`
	User    *User    `json:"user"`
	Message *Message `json:"message"`

	CreatedAt  time.Time `json:"created_at"`
	UpdatedAt  time.Time `json:"updated_at"`
	ReviewedAt time.Time `json:"reviewed_at"`
	ReviewedBy *User     `json:"reviewed_by"`
	ApprovedAt time.Time `json:"approved_at"`
	RejectedAt time.Time `json:"rejected_at"`
}

type MessagePaginationParamsRequest added in v5.1.0 

type MessagePaginationParamsRequest struct {
	PaginationParamsRequest
	CreatedAtAfterEq  *time.Time `json:"created_at_after_or_equal,omitempty"`
	CreatedAtAfter    *time.Time `json:"created_at_after,omitempty"`
	CreatedAtBeforeEq *time.Time `json:"created_at_before_or_equal,omitempty"`
	CreatedAtBefore   *time.Time `json:"created_at_before,omitempty"`
	IDAround          string     `json:"id_around,omitempty"`
	CreatedAtAround   *time.Time `json:"created_at_around,omitempty"`
}

type MessagePartialUpdateRequest 

type MessagePartialUpdateRequest struct {
	PartialUpdate
	UserID        string `json:"user_id"`
	SkipEnrichURL bool   `json:"skip_enrich_url"`
}

type MessageResponse 

type MessageResponse struct {
	Message *Message `json:"message"`

	Response
}

type MessageType 

type MessageType string
const (
	MessageTypeRegular   MessageType = "regular"
	MessageTypeError     MessageType = "error"
	MessageTypeReply     MessageType = "reply"
	MessageTypeSystem    MessageType = "system"
	MessageTypeEphemeral MessageType = "ephemeral"
)

type Mute 

type Mute struct {
	User      User       `json:"user"`
	Target    User       `json:"target"`
	CreatedAt time.Time  `json:"created_at"`
	UpdatedAt time.Time  `json:"updated_at"`
	Expires   *time.Time `json:"expires"`
}

Mute represents a user mute.

type MuteOption 

type MuteOption func(*muteOptions)

type PaginationParamsRequest added in v5.1.0 

type PaginationParamsRequest struct {
	Limit  int    `json:"limit,omitempty"`
	Offset int    `json:"offset,omitempty"`
	IDGTE  string `json:"id_gte,omitempty"`
	IDGT   string `json:"id_gt,omitempty"`
	IDLTE  string `json:"id_lte,omitempty"`
	IDLT   string `json:"id_lt,omitempty"`
}

type PartialUpdate 

type PartialUpdate struct {
	Set   map[string]interface{} `json:"set"`
	Unset []string               `json:"unset"`
}

type PartialUserUpdate 

type PartialUserUpdate struct {
	ID    string                 `json:"id"`              // User ID, required
	Set   map[string]interface{} `json:"set,omitempty"`   // map of field.name => value; optional
	Unset []string               `json:"unset,omitempty"` // list of field names to unset
}

PartialUserUpdate request; Set and Unset fields can be set at same time, but should not be same field, for example you cannot set 'field.path.name' and unset 'field.path' at the same time. Field path should not contain spaces or dots (dot is path separator).

type Permission 

type Permission struct {
	ID          string                 `json:"id"`
	Name        string                 `json:"name"`
	Description string                 `json:"description"`
	Action      string                 `json:"action"`
	Owner       bool                   `json:"owner"`
	SameTeam    bool                   `json:"same_team"`
	Condition   map[string]interface{} `json:"condition"`
	Custom      bool                   `json:"custom"`
	Level       string                 `json:"level"`
}

type PermissionClient 

type PermissionClient struct {
	// contains filtered or unexported fields
}

func (*PermissionClient) CreatePermission 

func (p *PermissionClient) CreatePermission(ctx context.Context, perm *Permission) (*Response, error)

CreatePermission creates a new permission.

func (*PermissionClient) CreateRole 

func (p *PermissionClient) CreateRole(ctx context.Context, name string) (*Response, error)

CreateRole creates a new role.

func (*PermissionClient) DeletePermission 

func (p *PermissionClient) DeletePermission(ctx context.Context, id string) (*Response, error)

DeletePermission deletes a permission by id.

func (*PermissionClient) DeleteRole 

func (p *PermissionClient) DeleteRole(ctx context.Context, name string) (*Response, error)

DeleteRole deletes an existing role by name.

func (*PermissionClient) GetPermission 

func (p *PermissionClient) GetPermission(ctx context.Context, id string) (*GetPermissionResponse, error)

GetPermission returns a permission by id.

func (*PermissionClient) ListPermissions 

func (p *PermissionClient) ListPermissions(ctx context.Context) (*ListPermissionsResponse, error)

ListPermissions returns all permissions of an app.

func (*PermissionClient) ListRoles 

func (p *PermissionClient) ListRoles(ctx context.Context) (*RolesResponse, error)

ListRole returns all roles.

func (*PermissionClient) UpdatePermission 

func (p *PermissionClient) UpdatePermission(ctx context.Context, id string, perm *Permission) (*Response, error)

UpdatePermission updates an existing permission by id. Only custom permissions can be updated.

type Policy 

type Policy struct {
	Name      string    `json:"name"`
	Resources []string  `json:"resources"`
	Roles     []string  `json:"roles"`
	Action    int       `json:"action"` // allow: 1, deny: 0
	Owner     bool      `json:"owner"`
	Priority  int       `json:"priority"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

type PushConfigRequest added in v5.1.0 

type PushConfigRequest struct {
	Version     string `json:"version,omitempty"`
	OfflineOnly bool   `json:"offline_only,omitempty"`
}

type PushNotificationFields 

type PushNotificationFields struct {
	Version        string         `json:"version"`
	OfflineOnly    bool           `json:"offline_only"`
	APNConfig      APNConfig      `json:"apn"`
	FirebaseConfig FirebaseConfig `json:"firebase"`
	HuaweiConfig   HuaweiConfig   `json:"huawei"`
	XiaomiConfig   XiaomiConfig   `json:"xiaomi"`
}

type PushProvider added in v5.7.0 

type PushProvider struct {
	Type           PushProviderType `json:"type"`
	Name           string           `json:"name"`
	Description    string           `json:"description,omitempty"`
	DisabledAt     *time.Time       `json:"disabled_at,omitempty"`
	DisabledReason string           `json:"disabled_reason,omitempty"`

	APNAuthKey string `json:"apn_auth_key,omitempty"`
	APNKeyID   string `json:"apn_key_id,omitempty"`
	APNTeamID  string `json:"apn_team_id,omitempty"`
	APNTopic   string `json:"apn_topic,omitempty"`

	FirebaseCredentials          string  `json:"firebase_credentials,omitempty"`
	FirebaseNotificationTemplate *string `json:"firebase_notification_template,omitempty"`
	FirebaseAPNTemplate          *string `json:"firebase_apn_template,omitempty"`

	HuaweiAppID     string `json:"huawei_app_id,omitempty"`
	HuaweiAppSecret string `json:"huawei_app_secret,omitempty"`

	XiaomiPackageName string `json:"xiaomi_package_name,omitempty"`
	XiaomiAppSecret   string `json:"xiaomi_app_secret,omitempty"`
}

type PushProviderListResponse added in v5.7.0 

type PushProviderListResponse struct {
	Response
	PushProviders []PushProvider `json:"push_providers"`
}

type PushProviderType added in v5.7.0 

type PushProviderType = string

type QueryBannedUsersOptions 

type QueryBannedUsersOptions struct {
	*QueryOption
}

type QueryBannedUsersResponse 

type QueryBannedUsersResponse struct {
	Bans []*Ban `json:"bans"`
	Response
}

type QueryChannelsResponse 

type QueryChannelsResponse struct {
	Channels []*Channel
	Response
}

type QueryFlagReportsRequest added in v5.7.0 

type QueryFlagReportsRequest struct {
	FilterConditions map[string]interface{} `json:"filter_conditions,omitempty"`
	Limit            int                    `json:"limit,omitempty"`
	Offset           int                    `json:"offset,omitempty"`
}

type QueryFlagReportsResponse added in v5.7.0 

type QueryFlagReportsResponse struct {
	Response
	FlagReports []*FlagReport `json:"flag_reports"`
}

type QueryMembersResponse 

type QueryMembersResponse struct {
	Members []*ChannelMember `json:"members"`

	Response
}

type QueryMessageFlagsResponse 

type QueryMessageFlagsResponse struct {
	Flags []*MessageFlag `json:"flags"`
	Response
}

type QueryOption 

type QueryOption struct {
	// https://getstream.io/chat/docs/#query_syntax
	Filter map[string]interface{} `json:"filter_conditions,omitempty"`
	Sort   []*SortOption          `json:"sort,omitempty"`

	UserID       string `json:"user_id,omitempty"`
	Limit        int    `json:"limit,omitempty"`  // pagination option: limit number of results
	Offset       int    `json:"offset,omitempty"` // pagination option: offset to return items from
	MessageLimit *int   `json:"message_limit,omitempty"`
	MemberLimit  *int   `json:"member_limit,omitempty"`
}

type QueryRequest added in v5.1.0 

type QueryRequest struct {
	Data     *ChannelRequest                 `json:"data,omitempty"`
	Watch    bool                            `json:"watch,omitempty"`
	State    bool                            `json:"state,omitempty"`
	Presence bool                            `json:"presence,omitempty"`
	Messages *MessagePaginationParamsRequest `json:"messages,omitempty"`
	Members  *PaginationParamsRequest        `json:"members,omitempty"`
	Watchers *PaginationParamsRequest        `json:"watchers,omitempty"`
}

type QueryResponse added in v5.1.0 

type QueryResponse struct {
	Channel        *Channel         `json:"channel,omitempty"`
	Messages       []*Message       `json:"messages,omitempty"`
	PinnedMessages []*Message       `json:"pinned_messages,omitempty"`
	Members        []*ChannelMember `json:"members,omitempty"`
	Read           []*ChannelRead   `json:"read,omitempty"`

	Response
}

type QueryUsersResponse 

type QueryUsersResponse struct {
	Users []*User `json:"users"`
	Response
}

type RateLimitInfo 

type RateLimitInfo struct {
	// Limit is the maximum number of API calls for a single time window (1 minute).
	Limit int64 `json:"limit"`
	// Remaining is the number of API calls remaining in the current time window (1 minute).
	Remaining int64 `json:"remaining"`
	// Reset is the Unix timestamp of the expiration of the current rate limit time window.
	Reset int64 `json:"reset"`
}

RateLimitInfo represents the quota and usage for a single endpoint.

func NewRateLimitFromHeaders 

func NewRateLimitFromHeaders(headers http.Header) *RateLimitInfo

func (RateLimitInfo) ResetTime 

func (i RateLimitInfo) ResetTime() time.Time

ResetTime is a simple helper to get the time.Time representation of the Reset field of the given limit window.

type RateLimitsMap 

type RateLimitsMap map[string]RateLimitInfo

RateLimitsMap holds the rate limit information, where the keys are the names of the endpoints and the values are the related RateLimitInfo containing the quota, usage, and reset data.

type Reaction 

type Reaction struct {
	MessageID string `json:"message_id"`
	UserID    string `json:"user_id"`
	Type      string `json:"type"`

	// any other fields the user wants to attach a reaction
	ExtraData map[string]interface{} `json:"-"`
}

func (Reaction) MarshalJSON 

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

func (*Reaction) UnmarshalJSON 

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

type ReactionResponse 

type ReactionResponse struct {
	Message  *Message  `json:"message"`
	Reaction *Reaction `json:"reaction"`
	Response
}

type ReactionsResponse 

type ReactionsResponse struct {
	Reactions []*Reaction `json:"reactions"`
	Response
}

type ReactivateUserOptions 

type ReactivateUserOptions func(*reactivateUserOptions)

type RepliesResponse 

type RepliesResponse struct {
	Messages []*Message `json:"messages"`
	Response
}

type Response 

type Response struct {
	RateLimitInfo *RateLimitInfo `json:"ratelimit"`
}

Response is the base response returned to client. It contains rate limit information. All specific response returned to the client should embed this type.

type ReviewFlagReportRequest added in v5.7.0 

type ReviewFlagReportRequest struct {
	ReviewResult  string                 `json:"review_result,omitempty"`
	UserID        string                 `json:"user_id,omitempty"`
	ReviewDetails map[string]interface{} `json:"review_details,omitempty"`
}

type ReviewFlagReportResponse added in v5.7.0 

type ReviewFlagReportResponse struct {
	Response
	FlagReport *ExtendedFlagReport `json:"flag_report"`
}

type Role 

type Role struct {
	Name      string    `json:"name"`
	Custom    bool      `json:"custom"`
	Scopes    []string  `json:"scoped"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

type RoleAssignment 

type RoleAssignment struct {
	// UserID is the ID of the user to assign the role to.
	UserID string `json:"user_id"`

	// ChannelRole is the role to assign to the user.
	ChannelRole string `json:"channel_role"`
}

type RolesResponse 

type RolesResponse struct {
	Roles []*Role `json:"roles"`
	Response
}

type SearchFullResponse 

type SearchFullResponse struct {
	Results  []SearchMessageResponse `json:"results"`
	Next     string                  `json:"next,omitempty"`
	Previous string                  `json:"previous,omitempty"`
	Response
}

type SearchMessageResponse 

type SearchMessageResponse struct {
	Message *Message `json:"message"`
}

type SearchRequest 

type SearchRequest struct {
	// Required
	Query          string                 `json:"query"`
	Filters        map[string]interface{} `json:"filter_conditions"`
	MessageFilters map[string]interface{} `json:"message_filter_conditions"`

	// Pagination, optional
	Limit  int    `json:"limit,omitempty"`
	Offset int    `json:"offset,omitempty"`
	Next   string `json:"next,omitempty"`

	// Sort, optional
	Sort []SortOption `json:"sort,omitempty"`
}

type SearchResponse 

type SearchResponse struct {
	Messages []*Message
	Response
}

type SendFileRequest 

type SendFileRequest struct {
	Reader io.Reader `json:"-"`
	// name of the file would be stored
	FileName string
	// User object; required
	User *User
}

type SendFileResponse 

type SendFileResponse struct {
	File string `json:"file"`
	Response
}

type SendMessageOption 

type SendMessageOption func(*messageRequest)

SendMessageOption is an option that modifies behavior of send message request.

type SortOption 

type SortOption struct {
	Field     string `json:"field"`     // field name to sort by,from json tags(in camel case), for example created_at
	Direction int    `json:"direction"` // [-1, 1]
}

type TaskResponse 

type TaskResponse struct {
	TaskID    string     `json:"task_id"`
	Status    TaskStatus `json:"status"`
	CreatedAt time.Time  `json:"created_at"`
	UpdatedAt time.Time  `json:"updated_at"`

	Result map[string]interface{} `json:"result,omitempty"`
	Response
}

type TaskStatus 

type TaskStatus string
const (
	TaskStatusWaiting   TaskStatus = "waiting"
	TaskStatusPending   TaskStatus = "pending"
	TaskStatusRunning   TaskStatus = "running"
	TaskStatusCompleted TaskStatus = "completed"
	TaskStatusFailed    TaskStatus = "failed"
)

type Thresholds 

type Thresholds struct {
	Explicit *LabelThresholds `json:"explicit"`
	Spam     *LabelThresholds `json:"spam"`
	Toxic    *LabelThresholds `json:"toxic"`
}

type TranslationResponse added in v5.1.0 

type TranslationResponse struct {
	Message *Message `json:"message"`
	Response
}

type TruncateOption 

type TruncateOption func(*truncateOptions)

type TruncateResponse added in v5.8.0 

type TruncateResponse struct {
	Response
	Channel *Channel `json:"channel"`
	Message *Message `json:"message"`
}

type UpsertUserResponse 

type UpsertUserResponse struct {
	User *User
	Response
}

type User 

type User struct {
	ID       string   `json:"id"`
	Name     string   `json:"name,omitempty"`
	Image    string   `json:"image,omitempty"`
	Role     string   `json:"role,omitempty"`
	Teams    []string `json:"teams,omitempty"`
	Language string   `json:"language,omitempty"`

	Online    bool `json:"online,omitempty"`
	Invisible bool `json:"invisible,omitempty"`

	CreatedAt  *time.Time `json:"created_at,omitempty"`
	UpdatedAt  *time.Time `json:"updated_at,omitempty"`
	LastActive *time.Time `json:"last_active,omitempty"`

	Mutes                    []*Mute                `json:"mutes,omitempty"`
	ChannelMutes             []*ChannelMute         `json:"channel_mutes,omitempty"`
	ExtraData                map[string]interface{} `json:"-"`
	RevokeTokensIssuedBefore *time.Time             `json:"revoke_tokens_issued_before,omitempty"`
}

func (User) MarshalJSON 

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

MarshalJSON implements json.Marshaler.

func (*User) UnmarshalJSON 

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

UnmarshalJSON implements json.Unmarshaler.

type UserCustomEvent 

type UserCustomEvent struct {
	// Type should be a custom type. Using a built-in event is not supported here.
	Type string `json:"type"`

	ExtraData map[string]interface{} `json:"-"`

	CreatedAt time.Time `json:"created_at,omitempty"`
}

UserCustomEvent is a custom event sent to a particular user.

func (UserCustomEvent) MarshalJSON 

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

func (*UserCustomEvent) UnmarshalJSON 

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

type UsersResponse 

type UsersResponse struct {
	Users map[string]*User `json:"users"`
	Response
}

type XiaomiConfig added in v5.1.0 

type XiaomiConfig struct {
	Enabled bool `json:"enabled"`
}

type XiaomiConfigRequest added in v5.1.0 

type XiaomiConfigRequest struct {
	PackageName string `json:"package_name"`
	Secret      string `json:"secret"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.