Classes | |
class | ChannelType |
class | DateTimeHelper |
class | FileUploadWithProgressHandler |
class | MessageTypeFilter |
Public Types | |
enum | ReportCategory { SUSPICIOUS, HARASSING, SPAM, INAPPROPRIATE } |
Public Member Functions | |
bool | IsOpenChannel () |
bool | IsGroupChannel () |
PreviousMessageListQuery | CreatePreviousMessageListQuery () |
MessageListQuery | CreateMessageListQuery () |
OperatorListQuery | CreateOperatorListQuery () |
virtual byte[] | Serialize () |
FileMessage | SendFileMessageWithURL (string fileUrl, string name, string type, int size, string data, SendFileMessageHandler handler) |
FileMessage | SendFileMessageWithURL (string fileUrl, string name, string type, int size, string data, string customType, SendFileMessageHandler handler) |
FileMessage | SendFileMessage (FileMessageParams param, SendFileMessageHandler handler) |
void | GetMessagesByTimestamp (long ts, MessageListParams param, GetMessagesHandler handler) |
void | GetPreviousMessagesByTimestamp (long ts, bool isInclusive, int prevResultSize, bool reverse, MessageTypeFilter messageType, string customType, GetMessagesHandler handler) |
FileMessage | SendFileMessage (SBFile file, string name, string type, int size, string data, SendFileMessageHandler handler) |
FileMessage | SendFileMessage (SBFile file, string name, string type, int size, string data, FileUploadWithProgressHandler handler) |
FileMessage | SendFileMessage (SBFile file, string name, string type, int size, string data, string customType, FileUploadWithProgressHandler handler) |
FileMessage | SendFileMessage (SBFile file, string name, string type, int size, string data, string customType, SendFileMessageHandler handler) |
UserMessage | SendUserMessage (string message, SendUserMessageHandler handler) |
UserMessage | SendUserMessage (string message, string data, SendUserMessageHandler handler) |
UserMessage | SendUserMessage (string message, string data, string customType, SendUserMessageHandler handler) |
UserMessage | SendUserMessage (string message, string data, string customType, List< string > targetLangs, SendUserMessageHandler handler) |
UserMessage | SendUserMessage (UserMessageParams param, SendUserMessageHandler handler) |
void | CreateMetaCounters (Dictionary< string, int > metaCounterMap, MetaCounterHandler handler) |
void | UpdateMetaCounters (Dictionary< string, int > metaCounterMap, MetaCounterHandler handler) |
void | IncreaseMetaCounters (Dictionary< string, int > metaCounterMap, MetaCounterHandler handler) |
void | DecreaseMetaCounters (Dictionary< string, int > metaCounterMap, MetaCounterHandler handler) |
void | GetMetaCounters (List< string > keys, MetaCounterHandler handler) |
void | GetAllMetaCounters (MetaCounterHandler handler) |
void | DeleteMetaCounter (string key, DeleteMetaCounterHandler handler) |
void | DeleteAllMetaCounters (DeleteMetaCounterHandler handler) |
void | CreateMetaData (Dictionary< string, string > metaDataMap, MetaDataHandler handler) |
void | UpdateMetaData (Dictionary< string, string > metaDataMap, MetaDataHandler handler) |
void | GetMetaData (List< string > keys, MetaDataHandler handler) |
void | GetAllMetaData (MetaDataHandler handler) |
void | DeleteMetaData (string key, DeleteMetaDataHandler handler) |
void | DeleteAllMetaData (DeleteMetaDataHandler handler) |
void | DeleteMessage (BaseMessage message, DeleteMessageHandler handler) |
void | UpdateUserMessage (long messageId, string message, string data, string customType, UpdateMessageHandler handler) |
void | UpdateUserMessage (long messageId, UserMessageParams param, UpdateUserMessageHandler handler) |
void | UpdateFileMessage (long messageId, FileMessageParams param, UpdateFileMessageHandler handler) |
void | Report (ReportCategory reportCategory, string reportDescription, ReportHandler handler) |
void | ReportUser (User offendingUser, ReportCategory reportCategory, string reportDescription, ReportUserHandler handler) |
void | ReportMessage (BaseMessage message, ReportCategory reportCategory, string reportDescription, ReportMessageHandler handler) |
void | AddOperators (List< string > userIds, AddOperatorsHandler handler) |
void | RemoveOperators (List< string > userIds, RemoveOperatorsHandler handler) |
void | RemoveAllOperators (RemoveAllOperatorsHandler handler) |
void | GetMyMutedInfo (GetMyMutedInfoHandler handler) |
delegate void | OnGetChannelHandler (BaseChannel baseChannel, SendBirdException e) |
delegate void | MetaCounterHandler (Dictionary< string, int > metaCounterMap, SendBirdException e) |
delegate void | DeleteMetaCounterHandler (SendBirdException e) |
delegate void | MetaDataHandler (Dictionary< string, string > metaDataMap, SendBirdException e) |
delegate void | DeleteMetaDataHandler (SendBirdException e) |
delegate void | SendUserMessageHandler (UserMessage message, SendBirdException e) |
delegate void | SendFileMessageHandler (FileMessage message, SendBirdException e) |
delegate void | DeleteMessageHandler (SendBirdException e) |
delegate void | UpdateMessageHandler (UserMessage message, SendBirdException e) |
delegate void | ReportHandler (SendBirdException e) |
delegate void | ReportUserHandler (SendBirdException e) |
delegate void | ReportMessageHandler (SendBirdException e) |
delegate void | SendFileMessagesHandler (FileMessage message, SendBirdException e) |
delegate void | SendFileMessageWithProgressHandler (FileMessage message, SendBirdException e) |
delegate void | SendFileMessagesWithProgressHandler (FileMessage message, SendBirdException e) |
delegate void | SendFileMessagesWithProgressHandlerOnProgress (string reqId, int bytesSent, int totalBytesSent, int totalBytesToSend) |
delegate void | UpdateUserMessageHandler (UserMessage message, SendBirdException e) |
delegate void | UpdateFileMessageHandler (FileMessage message, SendBirdException e) |
delegate void | GetMyMutedInfoHandler (bool isMuted, string description, long startAt, long endAt, long remainingDuration, SendBirdException e) |
delegate void | AddOperatorsHandler (SendBirdException e) |
delegate void | RemoveOperatorsHandler (SendBirdException e) |
delegate void | RemoveAllOperatorsHandler (SendBirdException e) |
delegate void | GetMessagesHandler (List< BaseMessage > message, SendBirdException e) |
Static Public Member Functions | |
static string | Base64Decode (string data) |
static byte[] | Base64Encode (string data) |
static BaseChannel | BuildFromSerializedData (byte[] data) |
Properties | |
string | Data [get] |
new string | GetType [get] |
string | CustomType [get] |
string | Url [get] |
long | CreatedAt [get] |
string | Name [get] |
string | CoverUrl [get] |
bool | IsEphemeral [get] |
Objects representing a channel.
|
strong |
Report category.
|
inline |
Add operators to the channel. See https://docs.sendbird.com/platform/user_type#3_operator for the explanations on the operators.
userIds | user ids to add as operators. If empty or null, SendBirdException with error code {@value com.sendbird.android.SendBirdError::ERR_INVALID_PARAMETER} is passed to the handler. |
handler | handler to register |
|
inlinestatic |
Builds GroupChannel
or OpenChannel
instance from serialized data generated by serialize().
data | Serialized GroupChannel or OpenChannel data. |
GroupChannel
or OpenChannel
instance.
|
inline |
Creates message list query for this channel.
|
inline |
Creates meta counters. This can be used to customize the channel.
metaCounterMap | Meta counter key-value map. |
handler | Callback handler. |
|
inline |
Creates meta data. This can be used to customize the channel.
metaDataMap | Meta data key-value map. |
handler | Callback handler. |
|
inline |
Creates a query instance to get the operator list from this channel.
|
inline |
Creates previous message list query for this channel.
|
inline |
Decreases meta counters. This decreases atomically the keyed meta counter by the specified value.
metaCounterMap | Meta counter key-value map to decrease by the specified value. |
handler | Callback handler. |
|
inline |
Deletes all meta counters.
handler | Callback handler. |
|
inline |
Deletes all meta data.
handler | Callback handler. |
|
inline |
Deletes a message.
message | Message to delete. |
handler | Callback handler. |
delegate void SendBird.BaseChannel.DeleteMessageHandler | ( | SendBirdException | e | ) |
DeleteMessage handler. This provides callback for DeleteMessage(BaseMessage, DeleteMessageHandler).
|
inline |
Deletes a meta counter.
key | Meta counter key to delete. |
handler | Callback handler. |
delegate void SendBird.BaseChannel.DeleteMetaCounterHandler | ( | SendBirdException | e | ) |
DeleteMetaCounter handler. This provides callback for DeleteMetaCounter(string, DeleteMetaCounterHandler) and DeleteAllMetaCounters(DeleteMetaCounterHandler).
|
inline |
Deletes a meta data.
key | Meta data key to delete. |
handler | Callback handler. |
delegate void SendBird.BaseChannel.DeleteMetaDataHandler | ( | SendBirdException | e | ) |
DeleteMetaData handler. This provides callback for DeleteMetaData(string, DeleteMetaDataHandler) and DeleteAllMetaData(DeleteMetaDataHandler).
|
inline |
Get all meta counters.
handler | Callback handler. |
|
inline |
Gets all meta data.
handler | Callback handler. |
|
inline |
Retrieves previous or next messages based on the timestamp in a specific channel. The result is passed to handler
as list
.
ts | Specifies the timestamp to be the reference point for messages to retrieve, in Unix milliseconds format. |
params | Params for getting message list. See MessageListParams |
handler | Callback handler. |
|
inline |
Gets meta counters.
keys | Meta counters to get. |
handler | Callback handler. |
|
inline |
Gets meta data.
keys | Meta data to get. |
handler | Callback handler. |
|
inline |
Gets my muted information in this channel.
handler | Callback handler. |
|
inline |
Requests the previous messages from given timestamp. The result is passed to handler
as list
.
ts | Starting message timestamp to load. Messages created before this timestamp will be returned. |
isInclusive | Whether messages sent exactly on the timestamp should be loaded. |
prevResultSize | The number of messages sent to prior to the timestamp that should be loaded. |
reverse | If true the result will be returned by creation time descending order. |
messageType | Returns messages whose type matches BaseChannel.MessageTypeFilter. |
customType | Returns messages that have a matching custom type. If left blank, messages of all custom types are returned. |
handler | Callback handler. |
|
inline |
Increases meta counters. This increases atomically the keyed meta counter by the specified value.
metaCounterMap | Meta counter key-value map to increase by the specified value. |
handler | Callback handler. |
|
inline |
Checks whether the instance is GroupChannel type.
|
inline |
Checks whether the instance is OpenChannel type.
delegate void SendBird.BaseChannel.MetaCounterHandler | ( | Dictionary< string, int > | metaCounterMap, |
SendBirdException | e | ||
) |
MetaCounter handler. This provides callback for all meta counter related methods. Refer to CreateMetaCounters(Map, MetaCounterHandler).
delegate void SendBird.BaseChannel.MetaDataHandler | ( | Dictionary< string, string > | metaDataMap, |
SendBirdException | e | ||
) |
MetaData handler. This provides callback for all meta data related methods. Refer to CreateMetaData(Map, MetaDataHandler).
|
inline |
Remove all operators from the channel. See https://docs.sendbird.com/platform/user_type#3_operator for the explanations on the operators.
handler | handler to register |
|
inline |
Remove operators from the channel. See https://docs.sendbird.com/platform/user_type#3_operator for the explanations on the operators.
userIds | user ids to remove from operators list. If empty or null, SendBirdException with error code {@value com.sendbird.android.SendBirdError::ERR_INVALID_PARAMETER} is passed to the handler. |
handler | handler to register |
|
inline |
Reports this channel of inappropriate activities.
reportCategory | ReportCategory. |
reportDescription | Report description. (optional) |
handler | Callback handler. |
delegate void SendBird.BaseChannel.ReportHandler | ( | SendBirdException | e | ) |
Report handler. This handler provides callback for report(ReportCategory, String, ReportHandler).
|
inline |
Reports a malicious message.
message | UserMessage or FileMessage. |
reportCategory | ReportCategory. |
reportDescription | Report description. (optional) |
handler | Callback handler. 2020.5 |
|
inline |
Reports a user of suspicious activities.
offendingUser | Offending user. |
reportCategory | ReportCategory. |
reportDescription | Report description. (optional) |
handler | Callback handler. 2020.5 |
|
inline |
Sends a file with given file information.
params | Params of file message. Refer to FileMessageParams. |
handler | Callback handler. |
FileMessage
instance with request ID.
|
inline |
Sends a file with given file information.
file | File to be sent. |
name | File name. |
type | File type. MIME is preferred. |
size | File size. |
data | Custom field. This can be used to customize the message. |
handler | Callback handler. |
FileMessage
instance with request ID.
|
inline |
Sends a file with given file information.
file | File to be sent. |
name | File name. |
type | File type. MIME is preferred. |
size | File size. |
data | Custom field. This can be used to customize the message. |
customType | Custom type. This can be used to set custom type of the message. |
handler | Callback handler. |
FileMessage
instance with request ID. delegate void SendBird.BaseChannel.SendFileMessageHandler | ( | FileMessage | message, |
SendBirdException | e | ||
) |
SendFileMessage handler. This provides callback for SendFileMessage(File, string, string, int, string, SendFileMessageHandler) and SendFileMessage(string, string, string, int, string, SendFileMessageHandler).
delegate void SendBird.BaseChannel.SendFileMessagesWithProgressHandlerOnProgress | ( | string | reqId, |
int | bytesSent, | ||
int | totalBytesSent, | ||
int | totalBytesToSend | ||
) |
A callback for while each file is being uploaded.
reqId | Request ID of FileMessage . |
bytesSent | Bytes sent since the last time this callback was called. |
totalBytesSent | Total number of bytes sent so far. |
totalBytesToSend | Total bytes to send. |
|
inline |
Sends a file with given file information.
fileUrl | URL of file to be sent. |
name | File name. |
type | File type. MIME is preferred. |
size | File size. |
data | Custom field. This can be used to customize the message. |
handler | Callback handler. |
FileMessage
instance with request ID.
|
inline |
Sends a file with given file information.
fileUrl | URL of file to be sent. |
name | File name. |
type | File type. MIME is preferred. |
size | File size. |
data | Custom field. This can be used to customize the message. |
customType | Custom type. This can be used to set custom type of the message. |
handler | Callback handler. |
FileMessage
instance with request ID.
|
inline |
Sends a user message.
message | string message. |
handler | Callback handler. |
UserMessage
instance with request ID.
|
inline |
Sends a user message.
message | string message. |
data | Custom field. This can be used to customize the message. |
handler | Callback handler. |
UserMessage
instance with request ID.
|
inline |
Sends a user message.
message | string message. |
data | Custom field. This can be used to customize the message. |
customType | Custom type. This can be used to set custom type of the message. |
targetLangs | Target language codes (for example "es" for spanish) the message will be translated to. |
handler | Callback handler. |
UserMessage
instance with request ID.
|
inline |
Sends a user message.
message | string message. |
data | Custom field. This can be used to customize the message. |
customType | Custom type. This can be used to set custom type of the message. |
handler | Callback handler. |
UserMessage
instance with request ID. delegate void SendBird.BaseChannel.SendUserMessageHandler | ( | UserMessage | message, |
SendBirdException | e | ||
) |
SendUserMessage handler. This provides callback for SendUserMessage(string, SendUserMessageHandler) and SendUserMessage(string, string, SendUserMessageHandler).
|
inlinevirtual |
Serializes the GroupChannel
or OpenChannel
instance. This byte array can be stored in the database in your application. The instance can be restored by buildFromSerializedData(byte[]).
GroupChannel
or OpenChannel
data.
|
inline |
Updates a FileMessage
that was previously sent in the channel. Note that the file itself cannot be changed; only the fields stored within the message can be modified.
messageId | The ID of the message. This must be a message that exists in the channel's history, or an error will be returned. |
params | FileMessageParams. |
handler | An UpdateFileMessageHandler to receive the callback from this method. |
|
inline |
Updates meta counters.
metaCounterMap | Meta counter key-value map to update. |
handler | Callback handler. |
|
inline |
Updates meta data.
metaDataMap | Meta data key-value map to update. |
handler | Callback handler. |
|
inline |
Updates a UserMessage
that was previously sent in the channel.
messageId | The ID of the message. This must be a message that exists in the channel's history, or an error will be returned. |
message | The new message body. This argument is optional and can be null. |
data | The new Data associated with the message. This argument is optional and can be null. |
customType | The new Custom Type associated with the message. This argument is optional and can be null. |
handler | An UpdateUserMessageHandler to receive the callback from this method. |
|
inline |
Updates a UserMessage
that was previously sent in the channel.
messageId | The ID of the message. This must be a message that exists in the channel's history, or an error will be returned. |
params | UserMessageParams. |
handler | An UpdateUserMessageHandler to receive the callback from this method. |
|
get |
Returns cover image URL.
|
get |
Returns channel creation time.
|
get |
Gets the channel custom type. You can set custom type of this channel by CreateChannel(List, boolean, string, object, string, string, GroupChannelCreateHandler) or CreateChannelWithUserIds(List, boolean, string, object, string, string, GroupChannelCreateHandler), UpdateChannel(boolean, string, object, string, string, GroupChannelUpdateHandler).
|
get |
Returns channel data.
|
get |
Checks if this channel is ephemeral.
true
if this channel is ephemeral.
|
get |
Returns topic or name of the channel.
|
get |
Returns unique channel URL.