Documentation ¶
Index ¶
- Constants
- func CheckSendbirdError(httpResp *http.Response) error
- type AdminMessage
- type BanAUserInOpenChannelRequest
- type BanAUserInOpenChannelResponse
- type BannedChannelResult
- type BannedResult
- type BlockAUserRequest
- type CheckIfMemberInGroupChannelResponse
- type Client
- func (c *Client) BanAUserInOpenChannel(channelURL string, r *BanAUserInOpenChannelRequest) (BanAUserInOpenChannelResponse, error)
- func (c *Client) BlockAUser(userID string, r *BlockAUserRequest) (User, error)
- func (c *Client) CheckIfMemberInGroupChannel(channelURL string, userID string) (CheckIfMemberInGroupChannelResponse, error)
- func (c *Client) CreateAChannelMetadata(channelType string, channelURL string, r *CreateAChannelMetadataRequest) (map[string]string, error)
- func (c *Client) CreateAGroupChannelWithFile(r *CreateAGroupChannelWithFileRequest) (GroupChannel, error)
- func (c *Client) CreateAGroupChannelWithURL(r *CreateAGroupChannelWithURLRequest) (GroupChannel, error)
- func (c *Client) CreateAUserWithFile(r *CreateAUserWithFileRequest) (User, error)
- func (c *Client) CreateAUserWithURL(r *CreateAUserWithURLRequest) (User, error)
- func (c *Client) CreateAnOpenChannelWithFile(r *CreateAnOpenChannelWithFileRequest) (OpenChannel, error)
- func (c *Client) CreateAnOpenChannelWithURL(r *CreateAnOpenChannelWithURLRequest) (OpenChannel, error)
- func (c *Client) CreateAnUserMetaData(userID string, r *CreateAnUserMetaDataRequest) (map[string]string, error)
- func (c *Client) CreateChannelMetaCounter(channelType string, channelURL string, r *CreateChannelMetaCounterRequest) (map[string]int, error)
- func (c *Client) DeleteAGroupChannel(channelURL string) (sendbirdErrorResponse, error)
- func (c *Client) DeleteAUser(userID string) (sendbirdErrorResponse, error)
- func (c *Client) DeleteAnOpenChannel(channelURL string) (sendbirdErrorResponse, error)
- func (c *Client) DeleteChannelMetaCounter(channelType string, channelURL string) (sendbirdErrorResponse, error)
- func (c *Client) DeleteChannelMetaCounterByKeyName(channelType string, channelURL string, keyName string) (sendbirdErrorResponse, error)
- func (c *Client) DeleteChannelMetaData(channelType string, channelURL string) (sendbirdErrorResponse, error)
- func (c *Client) DeleteChannelMetaDataByKeyName(channelType string, channelURL string, keyName string) (sendbirdErrorResponse, error)
- func (c *Client) DeleteUserMetaData(userID string) (sendbirdErrorResponse, error)
- func (c *Client) DeleteUserMetaDataItem(userID string, keyName string) (sendbirdErrorResponse, error)
- func (c *Client) FreezeAnGroupChannel(channelURL string, r *FreezeAnGroupChannelRequest) (GroupChannel, error)
- func (c *Client) FreezeAnOpenChannel(channelURL string, r *FreezeAnOpenChannelRequest) (OpenChannel, error)
- func (c *Client) GetChannelPushPerferences(userID string, channelURL string) (GetChannelPushPerferencesResponse, error)
- func (c *Client) GetPushPerferences(userID string) (GetPushPerferencesResponse, error)
- func (c *Client) GetUnreadMessageCount(userID string) (GetUnreadMessageCountResponse, error)
- func (c *Client) HideFromAGroupChannel(channelURL string, r *HideFromAGroupChannelRequest) (sendbirdErrorResponse, error)
- func (c *Client) InviteMembersToGroupChannel(channelURL string, r *InviteMembersToGroupChannelRequest) (GroupChannel, error)
- func (c *Client) LeaveFromAGroupChannel(channelURL string, r *LeaveFromAGroupChannelRequest) (sendbirdErrorResponse, error)
- func (c *Client) ListBannedChannels(userID string, r *ListBannedChannelsRequest) (ListBannedChannelsResponse, error)
- func (c *Client) ListBannedUsersInOpenChannel(channelURL string, r *ListBannedUsersInOpenChannelRequest) (ListBannedUsersInOpenChannelResponse, error)
- func (c *Client) ListBlockedUsers(userID string, r *ListBlockUsersRequest) (ListBlockUsersResponse, error)
- func (c *Client) ListDeviceTokens(userID string, tokenType string) (ListDeviceTokensResponse, error)
- func (c *Client) ListGroupChannels(r *ListGroupChannelsRequest) (ListGroupChannelsResponse, error)
- func (c *Client) ListMembersInGroupChannel(channelURL string, r *ListMembersInGroupChannelRequest) (ListMembersInGroupChannelResponse, error)
- func (c *Client) ListMutedChannels(userID string, r *ListMutedChannelsRequest) (ListMutedChannelsResponse, error)
- func (c *Client) ListMutedUsersInOpenChannel(channelURL string, r *ListMutedUsersInOpenChannelRequest) (ListMutedUsersInOpenChannelResponse, error)
- func (c *Client) ListMyGroupChannels(userID string, r *ListMyGroupChannelsRequest) (ListMyGroupChannelsResponse, error)
- func (c *Client) ListOpenChannelParticipants(channelURL string, r *ListOpenChannelParticipantsRequest) (ListOpenChannelParticipantsResponse, error)
- func (c *Client) ListOpenChannels(r *ListOpenChannelsRequest) (ListOpenChannelsResponse, error)
- func (c *Client) ListUserMetaData(userID string, r *ListUserMetaDataRequest) (map[string]string, error)
- func (c *Client) ListUsers(r *ListUsersRequest) (ListUsersResponse, error)
- func (c *Client) MarkAllMessagesAsRead(userID string) (sendbirdErrorResponse, error)
- func (c *Client) MuteAUserInOpenChannel(channelURL string, r *MuteAUserInOpenChannelRequest) (OpenChannel, error)
- func (c *Client) PrepareUrl(pathEncodedUrl string) *url.URL
- func (c *Client) RegisterADeviceToken(userID string, tokenType string, r *RegisterADeviceTokenRequest) (RegisterADeviceTokenResponse, error)
- func (c *Client) ResetPushPerferences(userID string) (sendbirdErrorResponse, error)
- func (c *Client) SendMessage(channelType, channelURL string, r *SendMessageRequest) (sendMessageResponse, error)
- func (c *Client) UnbanAUserInOpenChannel(channelURL string, bannedUserID string) (sendbirdErrorResponse, error)
- func (c *Client) UnblockAUser(userID string, targetID string) (sendbirdErrorResponse, error)
- func (c *Client) UnmuteAUserInOpenChannel(channelURL string, mutedUserID string) (sendbirdErrorResponse, error)
- func (c *Client) UnregisterADeviceToken(userID string, tokenType string, pushToken string) (UnregisterADeviceTokenResponse, error)
- func (c *Client) UnregisterAllDeviceTokens(userID string) (User, error)
- func (c *Client) UpdateAGroupChannel(channelURL string, r *UpdateAGroupChannelRequest) (GroupChannel, error)
- func (c *Client) UpdateAUserWithFile(userID string, r *UpdateAUserWithFileRequest) (User, error)
- func (c *Client) UpdateAUserWithURL(userID string, r *UpdateAUserWithURLRequest) (User, error)
- func (c *Client) UpdateAnOpenChannelWithFile(channelURL string, r *UpdateAnOpenChannelWithFileRequest) (OpenChannel, error)
- func (c *Client) UpdateAnOpenChannelWithURL(channelURL string, r *UpdateAnOpenChannelWithURLRequest) (OpenChannel, error)
- func (c *Client) UpdateBanInOpenChannel(channelURL string, bannedUserID string, r *UpdateBanInOpenChannelRequest) (BannedResult, error)
- func (c *Client) UpdateChannelMetaCounter(channelType string, channelURL string, r *UpdateChannelMetaCounterRequest) (map[string]int, error)
- func (c *Client) UpdateChannelMetaCounterByKeyName(channelType string, channelURL string, keyName string, ...) (map[string]int, error)
- func (c *Client) UpdateChannelMetaData(channelType string, channelURL string, r *UpdateChannelMetaDataRequest) (map[string]string, error)
- func (c *Client) UpdateChannelMetaDataByKeyName(channelType string, channelURL string, keyName string, ...) (map[string]string, error)
- func (c *Client) UpdateChannelPushPerferences(userID string, channelURL string, r *UpdateChannelPushPerferencesRequest) (UpdateChannelPushPerferencesResponse, error)
- func (c *Client) UpdatePushPerferences(userID string, r *UpdatePushPerferencesRequest) (UpdatePushPerferencesResponse, error)
- func (c *Client) UpdateUserMetaData(userID string, r *UpdateUserMetaDataRequest) (map[string]string, error)
- func (c *Client) UpdateUserMetaDataItem(userID string, keyName string, r *UpdateUserMetaDataItemRequest) (map[string]string, error)
- func (c *Client) ViewAGroupChannel(channelURL string, r *ViewAGroupChannelRequest) (GroupChannel, error)
- func (c *Client) ViewAMuteInOpenChannel(channelURL string, mutedUserID string) (ViewAMuteInOpenChannelResponse, error)
- func (c *Client) ViewAUser(userID string) (User, error)
- func (c *Client) ViewAnOpenChannel(channelURL string, r *ViewAnOpenChannelRequest) (OpenChannel, error)
- func (c *Client) ViewAnUserMetaData(userID string, keyName string) (map[string]string, error)
- func (c *Client) ViewBanInOpenChannel(channelURL string, bannedUserID string) (BannedResult, error)
- func (c *Client) ViewChannelMetaCounter(channelType string, channelURL string, r *ViewChannelMetaCounterRequest) (map[string]int, error)
- func (c *Client) ViewChannelMetaCounterByKeyName(channelType string, channelURL string, keyName string) (map[string]int, error)
- func (c *Client) ViewChannelMetadata(channelType string, channelURL string, r *ViewChannelMetadataRequest) (map[string]string, error)
- func (c *Client) ViewChannelMetadataByKeyName(channelType string, channelURL string, keyName string) (map[string]string, error)
- type ClientOption
- type CreateAChannelMetadataRequest
- type CreateAGroupChannelWithFileRequest
- type CreateAGroupChannelWithURLRequest
- type CreateAUserWithFileRequest
- type CreateAUserWithURLRequest
- type CreateAnOpenChannelWithFileRequest
- type CreateAnOpenChannelWithURLRequest
- type CreateAnUserMetaDataRequest
- type CreateChannelMetaCounterRequest
- type File
- type FileMessage
- type FreezeAnGroupChannelRequest
- type FreezeAnOpenChannelRequest
- type GetChannelPushPerferencesResponse
- type GetPushPerferencesResponse
- type GetUnreadMessageCountResponse
- type GroupChannel
- type HideFromAGroupChannelRequest
- type InviteMembersToGroupChannelRequest
- type LastMessage
- type LeaveFromAGroupChannelRequest
- type ListBannedChannelsRequest
- type ListBannedChannelsResponse
- type ListBannedUsersInOpenChannelRequest
- type ListBannedUsersInOpenChannelResponse
- type ListBlockUsersRequest
- type ListBlockUsersResponse
- type ListDeviceTokensResponse
- type ListGroupChannelsRequest
- type ListGroupChannelsResponse
- type ListMembersInGroupChannelRequest
- type ListMembersInGroupChannelResponse
- type ListMutedChannelsRequest
- type ListMutedChannelsResponse
- type ListMutedUsersInOpenChannelRequest
- type ListMutedUsersInOpenChannelResponse
- type ListMyGroupChannelsRequest
- type ListMyGroupChannelsResponse
- type ListOpenChannelParticipantsRequest
- type ListOpenChannelParticipantsResponse
- type ListOpenChannelsRequest
- type ListOpenChannelsResponse
- type ListUserMetaDataRequest
- type ListUsersRequest
- type ListUsersResponse
- type MuteAUserInOpenChannelRequest
- type OpenChannel
- type RegisterADeviceTokenRequest
- type RegisterADeviceTokenResponse
- type SendMessageRequest
- type TextMessage
- type UnregisterADeviceTokenResponse
- type UpdateAGroupChannelRequest
- type UpdateAUserWithFileRequest
- type UpdateAUserWithURLRequest
- type UpdateAnOpenChannelWithFileRequest
- type UpdateAnOpenChannelWithURLRequest
- type UpdateBanInOpenChannelRequest
- type UpdateChannelMetaCounterByKeyNameRequest
- type UpdateChannelMetaCounterRequest
- type UpdateChannelMetaDataByKeyNameRequest
- type UpdateChannelMetaDataRequest
- type UpdateChannelPushPerferencesRequest
- type UpdateChannelPushPerferencesResponse
- type UpdatePushPerferencesRequest
- type UpdatePushPerferencesResponse
- type UpdateUserMetaDataItemRequest
- type UpdateUserMetaDataRequest
- type User
- type ViewAGroupChannelRequest
- type ViewAMuteInOpenChannelResponse
- type ViewAnOpenChannelRequest
- type ViewChannelMetaCounterRequest
- type ViewChannelMetadataRequest
- type WebhookCallback
- type WebhookHelper
Constants ¶
View Source
const ( SendbirdAPITokenHeaderKey = "Api-Token" SendbirdContentTypeHeaderValue = "application/json, charset=utf8" )
View Source
const ( ListLimitUpperBound = 100 ListLimitLowerBound = 1 )
Sendbird list limits
View Source
const ( //Users SendbirdURLUsers = `/users` //Open Channels SendbirdURLOpenChannels = `/open_channels` //Group Channels SendbirdURLGroupChannels = `/group_channels` )
Sendbird urls template
View Source
const ( TokenTypeGCM = "GCM" TokenTypeAPNS = "APNS" )
Sendbird token type for push service
View Source
const ( ChannelTypeOpenChannel = "open_channels" ChannelTypeGroupChannel = "group_channels" )
Sendbird channel type
View Source
const ( SendbirdAPIErrorUniqueIDConstraint = "violates unique constraint" SendbirdAPIErrorChannelNotFound = "Channel not found" SendbirdAPIErrorUserNotFound = "User not found" SendbirdClientErrorKeyValueMismatch = "Key and value are mismatched." SendbirdClientErrorUnsupportMethod = "Unsupport http method." SendbirdClientErrorNotImplemented = "Not implemented." SendbirdClientErrorUnsuppoertedWebhookCategory = "Unsupport webhook category." )
View Source
const ( WebhookCategoryOpenChannelMsgSend webhookCategory = "open_channel:message_send" WebhookCategoryGroupChannelMsgSend webhookCategory = "group_channel:message_send" WebhookCategoryOpenChannelMsgDeleted webhookCategory = "open_channel:message_delete" WebhookCategoryGroupChannelMsgDeleted webhookCategory = "group_channel:message_delete" WebhookCategoryGroupChannelMsgRead webhookCategory = "group_channel:message_read" WebhookCategoryOpenChannelCreated webhookCategory = "open_channel:create" WebhookCategoryGroupChannelCreated webhookCategory = "group_channel:create" WebhookCategoryOpenChannelRemoved webhookCategory = "open_channel:remove" WebhookCategoryGroupChannelInvited webhookCategory = "group_channel:invite" WebhookCategoryGroupChannelJoined webhookCategory = "group_channel:join" WebhookCategoryGroupChannelDeclineInvite webhookCategory = "group_channel:decline_invite" WebhookCategoryUserBlocked webhookCategory = "user:block" WebhookCategoryUserUnblocked webhookCategory = "user:unblock" WebhookCategoryUserMsgRateLimitExceeded webhookCategory = "alert:user_message_rate_limit_exceeded" )
Variables ¶
This section is empty.
Functions ¶
func CheckSendbirdError ¶
Types ¶
type AdminMessage ¶
type BannedChannelResult ¶
type BannedChannelResult struct { StartAt int64 `json:"start_at"` EndAt int64 `json:"end_at"` Description string `json:"description"` Channel OpenChannel `json:"channel"` }
type BannedResult ¶
type BlockAUserRequest ¶
type BlockAUserRequest struct {
TargetID string `json:"target_id"`
}
type CheckIfMemberInGroupChannelResponse ¶
type CheckIfMemberInGroupChannelResponse struct {
IsMember bool `json:"is_member"`
}
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client may be used to make requests to Sendbird Platform APIs
func NewClient ¶
func NewClient(options ...ClientOption) (*Client, error)
NewClient is the factory function for Client struct
func (*Client) BanAUserInOpenChannel ¶
func (c *Client) BanAUserInOpenChannel(channelURL string, r *BanAUserInOpenChannelRequest) (BanAUserInOpenChannelResponse, error)
func (*Client) BlockAUser ¶
func (c *Client) BlockAUser(userID string, r *BlockAUserRequest) (User, error)
func (*Client) CheckIfMemberInGroupChannel ¶
func (c *Client) CheckIfMemberInGroupChannel(channelURL string, userID string) (CheckIfMemberInGroupChannelResponse, error)
func (*Client) CreateAChannelMetadata ¶
func (*Client) CreateAGroupChannelWithFile ¶
func (c *Client) CreateAGroupChannelWithFile(r *CreateAGroupChannelWithFileRequest) (GroupChannel, error)
func (*Client) CreateAGroupChannelWithURL ¶
func (c *Client) CreateAGroupChannelWithURL(r *CreateAGroupChannelWithURLRequest) (GroupChannel, error)
func (*Client) CreateAUserWithFile ¶
func (c *Client) CreateAUserWithFile(r *CreateAUserWithFileRequest) (User, error)
func (*Client) CreateAUserWithURL ¶
func (c *Client) CreateAUserWithURL(r *CreateAUserWithURLRequest) (User, error)
func (*Client) CreateAnOpenChannelWithFile ¶
func (c *Client) CreateAnOpenChannelWithFile(r *CreateAnOpenChannelWithFileRequest) (OpenChannel, error)
func (*Client) CreateAnOpenChannelWithURL ¶
func (c *Client) CreateAnOpenChannelWithURL(r *CreateAnOpenChannelWithURLRequest) (OpenChannel, error)
func (*Client) CreateAnUserMetaData ¶
func (*Client) CreateChannelMetaCounter ¶
func (*Client) DeleteAGroupChannel ¶
func (*Client) DeleteAUser ¶
func (*Client) DeleteAnOpenChannel ¶
func (*Client) DeleteChannelMetaCounter ¶
func (*Client) DeleteChannelMetaCounterByKeyName ¶
func (*Client) DeleteChannelMetaData ¶
func (*Client) DeleteChannelMetaDataByKeyName ¶
func (*Client) DeleteUserMetaData ¶
func (*Client) DeleteUserMetaDataItem ¶
func (*Client) FreezeAnGroupChannel ¶
func (c *Client) FreezeAnGroupChannel(channelURL string, r *FreezeAnGroupChannelRequest) (GroupChannel, error)
func (*Client) FreezeAnOpenChannel ¶
func (c *Client) FreezeAnOpenChannel(channelURL string, r *FreezeAnOpenChannelRequest) (OpenChannel, error)
func (*Client) GetChannelPushPerferences ¶
func (c *Client) GetChannelPushPerferences(userID string, channelURL string) (GetChannelPushPerferencesResponse, error)
func (*Client) GetPushPerferences ¶
func (c *Client) GetPushPerferences(userID string) (GetPushPerferencesResponse, error)
func (*Client) GetUnreadMessageCount ¶
func (c *Client) GetUnreadMessageCount(userID string) (GetUnreadMessageCountResponse, error)
func (*Client) HideFromAGroupChannel ¶
func (c *Client) HideFromAGroupChannel(channelURL string, r *HideFromAGroupChannelRequest) (sendbirdErrorResponse, error)
func (*Client) InviteMembersToGroupChannel ¶
func (c *Client) InviteMembersToGroupChannel(channelURL string, r *InviteMembersToGroupChannelRequest) (GroupChannel, error)
func (*Client) LeaveFromAGroupChannel ¶
func (c *Client) LeaveFromAGroupChannel(channelURL string, r *LeaveFromAGroupChannelRequest) (sendbirdErrorResponse, error)
func (*Client) ListBannedChannels ¶
func (c *Client) ListBannedChannels(userID string, r *ListBannedChannelsRequest) (ListBannedChannelsResponse, error)
func (*Client) ListBannedUsersInOpenChannel ¶
func (c *Client) ListBannedUsersInOpenChannel(channelURL string, r *ListBannedUsersInOpenChannelRequest) (ListBannedUsersInOpenChannelResponse, error)
func (*Client) ListBlockedUsers ¶
func (c *Client) ListBlockedUsers(userID string, r *ListBlockUsersRequest) (ListBlockUsersResponse, error)
func (*Client) ListDeviceTokens ¶
func (c *Client) ListDeviceTokens(userID string, tokenType string) (ListDeviceTokensResponse, error)
func (*Client) ListGroupChannels ¶
func (c *Client) ListGroupChannels(r *ListGroupChannelsRequest) (ListGroupChannelsResponse, error)
func (*Client) ListMembersInGroupChannel ¶
func (c *Client) ListMembersInGroupChannel(channelURL string, r *ListMembersInGroupChannelRequest) (ListMembersInGroupChannelResponse, error)
func (*Client) ListMutedChannels ¶
func (c *Client) ListMutedChannels(userID string, r *ListMutedChannelsRequest) (ListMutedChannelsResponse, error)
func (*Client) ListMutedUsersInOpenChannel ¶
func (c *Client) ListMutedUsersInOpenChannel(channelURL string, r *ListMutedUsersInOpenChannelRequest) (ListMutedUsersInOpenChannelResponse, error)
func (*Client) ListMyGroupChannels ¶
func (c *Client) ListMyGroupChannels(userID string, r *ListMyGroupChannelsRequest) (ListMyGroupChannelsResponse, error)
func (*Client) ListOpenChannelParticipants ¶
func (c *Client) ListOpenChannelParticipants(channelURL string, r *ListOpenChannelParticipantsRequest) (ListOpenChannelParticipantsResponse, error)
func (*Client) ListOpenChannels ¶
func (c *Client) ListOpenChannels(r *ListOpenChannelsRequest) (ListOpenChannelsResponse, error)
func (*Client) ListUserMetaData ¶
func (*Client) ListUsers ¶
func (c *Client) ListUsers(r *ListUsersRequest) (ListUsersResponse, error)
func (*Client) MarkAllMessagesAsRead ¶
func (*Client) MuteAUserInOpenChannel ¶
func (c *Client) MuteAUserInOpenChannel(channelURL string, r *MuteAUserInOpenChannelRequest) (OpenChannel, error)
func (*Client) RegisterADeviceToken ¶
func (c *Client) RegisterADeviceToken(userID string, tokenType string, r *RegisterADeviceTokenRequest) (RegisterADeviceTokenResponse, error)
func (*Client) ResetPushPerferences ¶
func (*Client) SendMessage ¶
func (c *Client) SendMessage(channelType, channelURL string, r *SendMessageRequest) (sendMessageResponse, error)
func (*Client) UnbanAUserInOpenChannel ¶
func (*Client) UnblockAUser ¶
func (*Client) UnmuteAUserInOpenChannel ¶
func (*Client) UnregisterADeviceToken ¶
func (*Client) UnregisterAllDeviceTokens ¶
func (*Client) UpdateAGroupChannel ¶
func (c *Client) UpdateAGroupChannel(channelURL string, r *UpdateAGroupChannelRequest) (GroupChannel, error)
func (*Client) UpdateAUserWithFile ¶
func (c *Client) UpdateAUserWithFile(userID string, r *UpdateAUserWithFileRequest) (User, error)
func (*Client) UpdateAUserWithURL ¶
func (c *Client) UpdateAUserWithURL(userID string, r *UpdateAUserWithURLRequest) (User, error)
func (*Client) UpdateAnOpenChannelWithFile ¶
func (c *Client) UpdateAnOpenChannelWithFile(channelURL string, r *UpdateAnOpenChannelWithFileRequest) (OpenChannel, error)
func (*Client) UpdateAnOpenChannelWithURL ¶
func (c *Client) UpdateAnOpenChannelWithURL(channelURL string, r *UpdateAnOpenChannelWithURLRequest) (OpenChannel, error)
func (*Client) UpdateBanInOpenChannel ¶
func (c *Client) UpdateBanInOpenChannel(channelURL string, bannedUserID string, r *UpdateBanInOpenChannelRequest) (BannedResult, error)
func (*Client) UpdateChannelMetaCounter ¶
func (*Client) UpdateChannelMetaCounterByKeyName ¶
func (*Client) UpdateChannelMetaData ¶
func (*Client) UpdateChannelMetaDataByKeyName ¶
func (*Client) UpdateChannelPushPerferences ¶
func (c *Client) UpdateChannelPushPerferences(userID string, channelURL string, r *UpdateChannelPushPerferencesRequest) (UpdateChannelPushPerferencesResponse, error)
func (*Client) UpdatePushPerferences ¶
func (c *Client) UpdatePushPerferences(userID string, r *UpdatePushPerferencesRequest) (UpdatePushPerferencesResponse, error)
func (*Client) UpdateUserMetaData ¶
func (*Client) UpdateUserMetaDataItem ¶
func (*Client) ViewAGroupChannel ¶
func (c *Client) ViewAGroupChannel(channelURL string, r *ViewAGroupChannelRequest) (GroupChannel, error)
func (*Client) ViewAMuteInOpenChannel ¶
func (c *Client) ViewAMuteInOpenChannel(channelURL string, mutedUserID string) (ViewAMuteInOpenChannelResponse, error)
func (*Client) ViewAnOpenChannel ¶
func (c *Client) ViewAnOpenChannel(channelURL string, r *ViewAnOpenChannelRequest) (OpenChannel, error)
func (*Client) ViewAnUserMetaData ¶
func (*Client) ViewBanInOpenChannel ¶
func (c *Client) ViewBanInOpenChannel(channelURL string, bannedUserID string) (BannedResult, error)
func (*Client) ViewChannelMetaCounter ¶
func (*Client) ViewChannelMetaCounterByKeyName ¶
func (*Client) ViewChannelMetadata ¶
type ClientOption ¶
ClientOption is the type of constructor options for NewClient(...).
func WithAPIKey ¶
func WithAPIKey(apiKey string) ClientOption
WithAPIKey configures a Maps API client with an API Key
func WithHTTPClient ¶
func WithHTTPClient(c *http.Client) ClientOption
WithHTTPClient configures a Maps API client with a http.Client to make requests over.
type CreateAGroupChannelWithFileRequest ¶
type CreateAGroupChannelWithFileRequest struct { Name string `json:"name,omitempty"` CoverFile []byte `json:"cover_file,omitempty"` CustomType string `json:"custom_type,omitempty"` Data string `json:"data,omitempty"` UserIDs []string `json:"user_ids,omitempty"` IsDistinct bool `json:"is_distinct,omitempty"` }
type CreateAGroupChannelWithURLRequest ¶
type CreateAGroupChannelWithURLRequest struct { Name string `json:"name,omitempty"` CoverURL string `json:"cover_url,omitempty"` CustomType string `json:"custom_type,omitempty"` Data string `json:"data,omitempty"` UserIDs []string `json:"user_ids,omitempty"` IsDistinct bool `json:"is_distinct,omitempty"` }
type CreateAnOpenChannelWithFileRequest ¶
type CreateAnOpenChannelWithFileRequest struct { Name string `json:"name,omitempty"` ChannelURL string `json:"channel_url,omitempty"` CoverFile []byte `json:"cover_file,omitempty"` CustomType string `json:"custom_type,omitempty"` Data string `json:"data,omitempty"` Operators []string `json:"operators,omitempty"` }
type CreateAnOpenChannelWithURLRequest ¶
type CreateAnOpenChannelWithURLRequest struct { Name string `json:"name,omitempty"` ChannelURL string `json:"channel_url,omitempty"` CoverURL string `json:"cover_url,omitempty"` CustomType string `json:"custom_type,omitempty"` Data string `json:"data,omitempty"` Operators []string `json:"operators,omitempty"` }
type FileMessage ¶
type FreezeAnGroupChannelRequest ¶
type FreezeAnGroupChannelRequest struct {
Freeze bool `json:"freeze"`
}
type FreezeAnOpenChannelRequest ¶
type FreezeAnOpenChannelRequest struct {
Freeze bool `json:"freeze"`
}
type GetChannelPushPerferencesResponse ¶
type GetChannelPushPerferencesResponse struct {
Enable bool `json:"enable"`
}
type GetPushPerferencesResponse ¶
type GetPushPerferencesResponse struct { DoNotDisturb bool `json:"do_not_disturb,omitempty"` StartHour int `json:"start_hour,omitempty"` StartMin int `json:"start_min,omitempty"` EndHour int `json:"end_hour,omitempty"` EndMin int `json:"end_min,omitempty"` TimeZone string `json:"timezone,omitempty"` }
type GetUnreadMessageCountResponse ¶
type GetUnreadMessageCountResponse struct {
UnreadCount int64 `json:"unread_count"`
}
type GroupChannel ¶
type GroupChannel struct { IsDistinct bool `json:"is_distinct"` MemberCount int `json:"member_count"` Members []User `json:"members"` ReadReceipt map[string]int64 `json:"read_receipt"` UnreadMessageCount int `json:"unread_message_count"` LastMessage LastMessage `json:"last_message"` // contains filtered or unexported fields }
type HideFromAGroupChannelRequest ¶
type HideFromAGroupChannelRequest struct {
UserID string `json:"user_id"`
}
type InviteMembersToGroupChannelRequest ¶
type InviteMembersToGroupChannelRequest struct {
UserIDs []string `json:"user_ids"`
}
type LastMessage ¶
type LeaveFromAGroupChannelRequest ¶
type LeaveFromAGroupChannelRequest struct {
UserIDs []string `json:"user_ids"`
}
type ListBannedChannelsResponse ¶
type ListBannedChannelsResponse struct { BannedChannels []BannedChannelResult `json:"banned_channels"` Next string `json:"next"` }
type ListBannedUsersInOpenChannelResponse ¶
type ListBannedUsersInOpenChannelResponse struct { BannedList []BannedResult `json:"banned_list"` Next string `json:"next"` }
type ListBlockUsersRequest ¶
type ListBlockUsersResponse ¶
type ListGroupChannelsRequest ¶
type ListGroupChannelsRequest struct { Token string `json:"token,omitempty"` Limit int `json:"limit,omitempty"` ShowMember bool `json:"show_member,omitempty"` ShowReadReceipt bool `json:"show_read_receipt,omitempty"` DistinctMode string `json:"distinct_mode,omitempty"` MembersExactlyIn []string `json:"members_exactly_in,omitempty"` MembersIncludeIn []string `json:"members_include_in,omitempty"` MembersNicknameContains []string `json:"members_nickname_contains,omitempty"` QueryType string `json:"query_type,omitempty"` CustomType string `json:"custom_type,omitempty"` ChannelURLs []string `json:"channel_urls,omitempty"` CreatedAfter int64 `json:"created_after,omitempty"` CreatedBefore int64 `json:"created_before,omitempty"` }
type ListGroupChannelsResponse ¶
type ListGroupChannelsResponse struct { Channels []GroupChannel `json:"channels"` Next string `json:"next"` }
type ListMutedChannelsResponse ¶
type ListMutedChannelsResponse struct { MutedChannels []OpenChannel `json:"muted_channels"` Next string `json:"next"` }
type ListMyGroupChannelsRequest ¶
type ListMyGroupChannelsRequest struct { Token string `json:"token,omitempty"` Limit int `json:"limit,omitempty"` ShowEmpty bool `json:"show_empty,omitempty"` ShowMember bool `json:"show_member,omitempty"` ShowReadReceipt bool `json:"show_read_receipt,omitempty"` DistinctMode string `json:"distinct_mode,omitempty"` Order string `json:"order,omitempty"` MembersExactlyIn []string `json:"members_exactly_in,omitempty"` MembersNicknameContains []string `json:"members_nickname_contains,omitempty"` MembersIncludeIn []string `json:"members_include_in,omitempty"` QueryType string `json:"query_type,omitempty"` CustomType string `json:"custom_type,omitempty"` ChannelURLs []string `json:"channel_urls,omitempty"` CreatedAfter int64 `json:"created_after,omitempty"` CreatedBefore int64 `json:"created_before,omitempty"` }
type ListMyGroupChannelsResponse ¶
type ListMyGroupChannelsResponse struct { Channels []GroupChannel `json:"channels"` Next string `json:"next"` }
type ListOpenChannelsRequest ¶
type ListOpenChannelsResponse ¶
type ListOpenChannelsResponse struct { Channels []OpenChannel `json:"channels"` Next string `json:"next"` }
type ListUserMetaDataRequest ¶
type ListUserMetaDataRequest struct {
Keys []string `json:"keys,omitempty"`
}
type ListUsersRequest ¶
type ListUsersResponse ¶
type MuteAUserInOpenChannelRequest ¶
type MuteAUserInOpenChannelRequest struct {
UserID string `json:"user_id"`
}
type OpenChannel ¶
type SendMessageRequest ¶
type TextMessage ¶
type UpdateAUserWithFileRequest ¶
type UpdateAUserWithFileRequest struct { NickName string `json:"nickname,omitempty"` ProfileFile string `json:"profile_file,omitempty"` IssueAccessToken bool `json:"issue_access_token,omitempty"` IsActive bool `json:"is_active,omitempty"` LeaveAllWhenDeactivated bool `json:"leave_all_when_deactivated,omitempty"` }
type UpdateAUserWithURLRequest ¶
type UpdateAUserWithURLRequest struct { NickName string `json:"nickname,omitempty"` ProfileURL string `json:"profile_url,omitempty"` IssueAccessToken bool `json:"issue_access_token,omitempty"` IsActive bool `json:"is_active,omitempty"` LeaveAllWhenDeactivated bool `json:"leave_all_when_deactivated,omitempty"` }
type UpdateChannelPushPerferencesRequest ¶
type UpdateChannelPushPerferencesRequest struct {
Enable bool `json:"enable"`
}
type UpdateChannelPushPerferencesResponse ¶
type UpdateChannelPushPerferencesResponse struct {
Enable bool `json:"enable"`
}
type UpdatePushPerferencesRequest ¶
type UpdatePushPerferencesRequest struct { DoNotDisturb bool `json:"do_not_disturb,omitempty"` StartHour int `json:"start_hour,omitempty"` StartMin int `json:"start_min,omitempty"` EndHour int `json:"end_hour,omitempty"` EndMin int `json:"end_min,omitempty"` TimeZone string `json:"timezone,omitempty"` }
type UpdatePushPerferencesResponse ¶
type UpdatePushPerferencesResponse struct { DoNotDisturb bool `json:"do_not_disturb,omitempty"` StartHour int `json:"start_hour,omitempty"` StartMin int `json:"start_min,omitempty"` EndHour int `json:"end_hour,omitempty"` EndMin int `json:"end_min,omitempty"` TimeZone string `json:"timezone,omitempty"` }
type UpdateUserMetaDataRequest ¶
type UpdateUserMetaDataRequest struct { MetaData interface{} `json:"metadata"` Upsert bool `json:"upsert,omitempty"` }
type User ¶
type User struct { UserID string `json:"user_id"` NickName string `json:"nickname"` ProfileURL string `json:"profile_url"` ProfileFile []byte `json:"profile_file"` AccessToken string `json:"access_token"` IsActive bool `json:"is_active"` IsOnline bool `json:"is_online"` LastSeenAt int64 `json:"last_seen_at"` }
type ViewAMuteInOpenChannelResponse ¶
type ViewAMuteInOpenChannelResponse struct {
IsMuted bool `json:"is_muted"`
}
type ViewAnOpenChannelRequest ¶
type ViewAnOpenChannelRequest struct {
Participants bool `json:"participants,omitempty"`
}
type ViewChannelMetaCounterRequest ¶
type ViewChannelMetaCounterRequest struct {
Keys []string `json:"keys"`
}
type ViewChannelMetadataRequest ¶
type ViewChannelMetadataRequest struct {
Keys []string `json:"keys"`
}
type WebhookCallback ¶
type WebhookCallback func(message interface{}) error
type WebhookHelper ¶
type WebhookHelper struct {
// contains filtered or unexported fields
}
func NewWebhookHelper ¶
func NewWebhookHelper() *WebhookHelper
func (*WebhookHelper) SendbirdWebhook ¶
func (wh *WebhookHelper) SendbirdWebhook(w http.ResponseWriter, req *http.Request)
func (*WebhookHelper) Subscribe ¶
func (h *WebhookHelper) Subscribe(callbackTopic webhookCategory, callback WebhookCallback)
Source Files ¶
Click to show internal directories.
Click to hide internal directories.