Method GetChannelTextMessageHistoryAsync
GetChannelTextMessageHistoryAsync(string, int, ChatHistoryQueryOptions)
Fetch Channel Text Messages for a given channel. Use chatHistoryQueryOptions to filter what is returned.
Declaration
Task<ReadOnlyCollection<VivoxMessage>> GetChannelTextMessageHistoryAsync(string channelName, int requestSize = 10, ChatHistoryQueryOptions chatHistoryQueryOptions = null)
Parameters
Type | Name | Description |
---|---|---|
string | channelName | The name of the channel the history will be fetched from. |
int | requestSize | The maximum number of messages to return. The larger this value is the longer the query will take to complete. Default is 10, keeping this number low is ideal. |
ChatHistoryQueryOptions | chatHistoryQueryOptions | ChatHistoryQueryOptions is used to customize the history results returned. |
Returns
Type | Description |
---|---|
Task<ReadOnlyCollection<VivoxMessage>> | Task with the ReadOnlyCollection of VivoxMessage |