Sendbird Chat SDK for Unity
Public Member Functions | List of all members
SbGroupChannelModule

Public Member Functions

void CreateChannel (SbGroupChannelCreateParams inChannelCreateParams, SbGroupChannelCallbackHandler inCompletionHandler)
 Creates a group channel with SbGroupChannelCreateParams class. More...
 
void GetChannel (string inChannelUrl, SbGetGroupChannelHandler inCompletionHandler)
 Gets a group channel instance from channel URL asynchronously. More...
 
SbGroupChannelListQuery CreateMyGroupChannelListQuery (SbGroupChannelListQueryParams inGroupChannelListQueryParams)
 Creates a query for my group channel list. More...
 
SbPublicGroupChannelListQuery CreatePublicGroupChannelListQuery (SbPublicGroupChannelListQueryParams inPublicGroupChannelListQueryParams)
 Creates a query for public group channel list. More...
 
void AddGroupChannelHandler (string inIdentifier, SbGroupChannelHandler inChannelHandler)
 Adds a channel handler. All added handlers will be notified when events occur. More...
 
void RemoveGroupChannelHandler (string inIdentifier)
 Removes a channel handler. The deleted handler no longer be notified. More...
 
void RemoveAllGroupChannelHandlers ()
 Removes all channel handlers added by AddGroupChannelHandler. More...
 
SbUnreadMessageCount GetUnreadMessageCount ()
 Gets the subscribed total unread message of current user. More...
 
int GetSubscribedTotalUnreadMessageCount ()
 Gets the subscribed total number of unread message of all GroupChannels the current user has joined. More...
 
int GetSubscribedCustomTypeTotalUnreadMessageCount ()
 Gets the total number of unread message of GroupChannels with subscribed custom types. More...
 
int GetSubscribedCustomTypeUnreadMessageCount (string inCustomType)
 Gets the number of unread message of GroupChannel with subscribed custom type. More...
 
void GetGroupChannelCount (SbMyMemberStateFilter inMyMemberStateFilter, SbCountHandler inCompletionHandler)
 Gets the number of my GroupChannels. More...
 
void GetTotalUnreadMessageCount (SbGroupChannelTotalUnreadMessageCountParams inParams, SbUnreadMessageCountHandler inCompletionHandler)
 Gets the total number of unread message of GroupChannels with SbGroupChannelTotalUnreadMessageCountParams filter. More...
 
void GetTotalUnreadChannelCount (SbGroupChannelTotalUnreadMessageCountParams inParams, SbCountHandler inCompletionHandler)
 Gets the total number of unread GroupChannels the current user has joined. More...
 
void GetUnreadItemCount (List< SbUnreadItemKey > inKeys, SbUnreadItemCountHandler inCompletionHandler)
 Gets the unread item count of GroupChannels from keys. More...
 
void MarkAsReadAll (SbErrorHandler inCompletionHandler)
 Sends mark as read to all joined GroupChannels. This method has rate limit. You can send one request per second. It returns SendbirdException if you exceed the rate limit. More...
 
void MarkAsReadWithChannelUrls (List< string > inChannelUrls, SbErrorHandler inCompletionHandler)
 Sends mark as read to joined GroupChannels. This method has rate limit. You can send one request per second. More...
 
void MarkAsDelivered (Dictionary< string, string > inData, SbErrorHandler inCompletionHandler)
 Sends mark as delivered to this channel when you received push message from us. More...
 
void GetMyGroupChannelChangeLogsByTimestamp (long inTimestamp, SbGroupChannelChangeLogsParams inParams, SbGroupChannelChangeLogsHandler inCompletionHandler)
 Requests the channel changelogs after given timestamp. The result is passed to handler. More...
 
void GetMyGroupChannelChangeLogsByToken (string inToken, SbGroupChannelChangeLogsParams inParams, SbGroupChannelChangeLogsHandler inCompletionHandler)
 Requests the channel changelogs from given token. The result is passed to handler. More...
 
SbGroupChannelCollection CreateGroupChannelCollection (SbGroupChannelCollectionCreateParams inGroupChannelCollectionCreateParams)
 Creates GroupChannelCollection instance with the params. More...
 

Detailed Description

Since
4.0.0

Member Function Documentation

◆ AddGroupChannelHandler()

void AddGroupChannelHandler ( string  inIdentifier,
SbGroupChannelHandler  inChannelHandler 
)

Adds a channel handler. All added handlers will be notified when events occur.

Parameters
inIdentifierThe identifier for handler.
inChannelHandler
Since
4.0.0

◆ CreateChannel()

void CreateChannel ( SbGroupChannelCreateParams  inChannelCreateParams,
SbGroupChannelCallbackHandler  inCompletionHandler 
)

Creates a group channel with SbGroupChannelCreateParams class.

Parameters
inChannelCreateParams
inCompletionHandler
Since
4.0.0

◆ CreateGroupChannelCollection()

SbGroupChannelCollection CreateGroupChannelCollection ( SbGroupChannelCollectionCreateParams  inGroupChannelCollectionCreateParams)

Creates GroupChannelCollection instance with the params.

Parameters
inGroupChannelCollectionCreateParams
Returns
Since
4.0.0

◆ CreateMyGroupChannelListQuery()

SbGroupChannelListQuery CreateMyGroupChannelListQuery ( SbGroupChannelListQueryParams  inGroupChannelListQueryParams)

Creates a query for my group channel list.

Parameters
inGroupChannelListQueryParams
Returns
Since
4.0.0

◆ CreatePublicGroupChannelListQuery()

SbPublicGroupChannelListQuery CreatePublicGroupChannelListQuery ( SbPublicGroupChannelListQueryParams  inPublicGroupChannelListQueryParams)

Creates a query for public group channel list.

Parameters
inPublicGroupChannelListQueryParams
Returns
Since
4.0.0

◆ GetChannel()

void GetChannel ( string  inChannelUrl,
SbGetGroupChannelHandler  inCompletionHandler 
)

Gets a group channel instance from channel URL asynchronously.

Parameters
inChannelUrl
inCompletionHandler
Since
4.0.0

◆ GetGroupChannelCount()

void GetGroupChannelCount ( SbMyMemberStateFilter  inMyMemberStateFilter,
SbCountHandler  inCompletionHandler 
)

Gets the number of my GroupChannels.

Parameters
inMyMemberStateFilter
inCompletionHandler
Since
4.0.0

◆ GetMyGroupChannelChangeLogsByTimestamp()

void GetMyGroupChannelChangeLogsByTimestamp ( long  inTimestamp,
SbGroupChannelChangeLogsParams  inParams,
SbGroupChannelChangeLogsHandler  inCompletionHandler 
)

Requests the channel changelogs after given timestamp. The result is passed to handler.

Parameters
inTimestamp
inParams
inCompletionHandler
Since
4.0.0

◆ GetMyGroupChannelChangeLogsByToken()

void GetMyGroupChannelChangeLogsByToken ( string  inToken,
SbGroupChannelChangeLogsParams  inParams,
SbGroupChannelChangeLogsHandler  inCompletionHandler 
)

Requests the channel changelogs from given token. The result is passed to handler.

Parameters
inToken
inParams
inCompletionHandler
Since
4.0.0

◆ GetSubscribedCustomTypeTotalUnreadMessageCount()

int GetSubscribedCustomTypeTotalUnreadMessageCount ( )

Gets the total number of unread message of GroupChannels with subscribed custom types.

Returns
Since
4.0.0

◆ GetSubscribedCustomTypeUnreadMessageCount()

int GetSubscribedCustomTypeUnreadMessageCount ( string  inCustomType)

Gets the number of unread message of GroupChannel with subscribed custom type.

Parameters
inCustomType
Returns
Since
4.0.0

◆ GetSubscribedTotalUnreadMessageCount()

int GetSubscribedTotalUnreadMessageCount ( )

Gets the subscribed total number of unread message of all GroupChannels the current user has joined.

Returns
Since
4.0.0

◆ GetTotalUnreadChannelCount()

void GetTotalUnreadChannelCount ( SbGroupChannelTotalUnreadMessageCountParams  inParams,
SbCountHandler  inCompletionHandler 
)

Gets the total number of unread GroupChannels the current user has joined.

Parameters
inParams
inCompletionHandler
Since
4.0.0

◆ GetTotalUnreadMessageCount()

void GetTotalUnreadMessageCount ( SbGroupChannelTotalUnreadMessageCountParams  inParams,
SbUnreadMessageCountHandler  inCompletionHandler 
)

Gets the total number of unread message of GroupChannels with SbGroupChannelTotalUnreadMessageCountParams filter.

Parameters
inParams
inCompletionHandler
Since
4.0.0

◆ GetUnreadItemCount()

void GetUnreadItemCount ( List< SbUnreadItemKey >  inKeys,
SbUnreadItemCountHandler  inCompletionHandler 
)

Gets the unread item count of GroupChannels from keys.

Parameters
inKeys
inCompletionHandler
Since
4.0.0

◆ GetUnreadMessageCount()

SbUnreadMessageCount GetUnreadMessageCount ( )

Gets the subscribed total unread message of current user.

Returns
Since
4.0.0

◆ MarkAsDelivered()

void MarkAsDelivered ( Dictionary< string, string >  inData,
SbErrorHandler  inCompletionHandler 
)

Sends mark as delivered to this channel when you received push message from us.

Parameters
inData
inCompletionHandler
Since
4.0.0

◆ MarkAsReadAll()

void MarkAsReadAll ( SbErrorHandler  inCompletionHandler)

Sends mark as read to all joined GroupChannels. This method has rate limit. You can send one request per second. It returns SendbirdException if you exceed the rate limit.

Parameters
inCompletionHandler
Since
4.0.0

◆ MarkAsReadWithChannelUrls()

void MarkAsReadWithChannelUrls ( List< string >  inChannelUrls,
SbErrorHandler  inCompletionHandler 
)

Sends mark as read to joined GroupChannels. This method has rate limit. You can send one request per second.

Parameters
inChannelUrls
inCompletionHandler
Since
4.0.0

◆ RemoveAllGroupChannelHandlers()

void RemoveAllGroupChannelHandlers ( )

Removes all channel handlers added by AddGroupChannelHandler.

Since
4.0.0

◆ RemoveGroupChannelHandler()

void RemoveGroupChannelHandler ( string  inIdentifier)

Removes a channel handler. The deleted handler no longer be notified.

Parameters
inIdentifierThe identifier for handler.
Since
4.0.0