Method GetDirectTextMessageHistoryAsync
GetDirectTextMessageHistoryAsync(string, int, ChatHistoryQueryOptions)
Fetch Direct Text Messages at an account level. Use chatHistoryQueryOptions to filter what is returned.
Declaration
Task<ReadOnlyCollection<VivoxMessage>> GetDirectTextMessageHistoryAsync(string playerId = null, int requestSize = 10, ChatHistoryQueryOptions chatHistoryQueryOptions = null)
Parameters
Type | Name | Description |
---|---|---|
string | playerId | The playerId of the logged in user you would like to search the chat history of. If this value is set then it takes priority over the chatHistoryQueryOptions value for PlayerId and it will be ignored. Otherwise that PlayerId will be used in the chatHistoryQueryOptions PlayerId is used. |
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 |