Class Sender

Utility helper for sending Wolf Client messages.

Inheritance
System.Object
Sender
Namespace: TehGM.Wolfringo
Assembly: Wolfringo.Utilities.dll
Syntax
public static class Sender
Remarks

Sender utility is designed to abstract most common actions from the message and response objects.

Methods are designed to make use of cached entities where possible.

This utility does not support any custom message or response classes designed by the developer.

Methods

| Improve this Doc View Source

AddContactAsync(IWolfClient, UInt32, CancellationToken)

Add contact.

Declaration
public static Task AddContactAsync(this IWolfClient client, uint userID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 userID

ID of user to add.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
Remarks

Before adding, it's recommended to check if user is already a contact. Adding user that's already in contacts list will result in an exception being thrown.

See Also
| Improve this Doc View Source

AdminUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)

Admin a group member.

Declaration
public static Task AdminUserAsync(this IWolfClient client, uint userID, uint groupID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to perform the admin action with.
System.UInt32 userID

User ID of group member to admin.
System.UInt32 groupID

ID of group to admin the user in.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
See Also
| Improve this Doc View Source

BanUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)

Ban a group member.

Declaration
public static Task BanUserAsync(this IWolfClient client, uint userID, uint groupID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to perform the admin action with.
System.UInt32 userID

User ID of group member to ban.
System.UInt32 groupID

ID of group to ban the user from.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
See Also
| Improve this Doc View Source

BlockUserAsync(IWolfClient, UInt32, CancellationToken)

Block user.

Declaration
public static Task BlockUserAsync(this IWolfClient client, uint userID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 userID

ID of user to block.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
See Also
| Improve this Doc View Source

ClearNotificationsAsync(IWolfClient, CancellationToken)

Clear notifications list.

Declaration
public static Task ClearNotificationsAsync(this IWolfClient client, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
See Also
| Improve this Doc View Source

CreateGroupAsync(IWolfClient, String, String, Action<GroupCreateMessage.Builder>, CancellationToken)

Creates a new group.

Declaration
public static async Task<WolfGroup> CreateGroupAsync(this IWolfClient client, string groupName, string groupDescription, Action<GroupCreateMessage.Builder> groupSettings, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.String groupName

Name of group to create.
System.String groupDescription

Short description for the group.
System.Action<GroupCreateMessage.Builder> groupSettings

Group profile settings to apply.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfGroup>

Profile of created group.
See Also
| Improve this Doc View Source

CreateGroupAsync(IWolfClient, String, String, CancellationToken)

Creates a new group.

Declaration
public static Task<WolfGroup> CreateGroupAsync(this IWolfClient client, string groupName, string groupDescription, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.String groupName

Name of group to create.
System.String groupDescription

Short description for the group.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfGroup>

Profile of created group.
See Also
| Improve this Doc View Source

DeleteChatMessageAsync(IWolfClient, ChatMessage, CancellationToken)

Requests chat message to be deleted.

Declaration
public static Task<ChatUpdateResponse> DeleteChatMessageAsync(this IWolfClient client, ChatMessage message, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the message with.
ChatMessage message

Chat message to delete.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<ChatUpdateResponse>

Message updating result.
| Improve this Doc View Source

DeleteContactAsync(IWolfClient, UInt32, CancellationToken)

Delete contact.

Declaration
public static Task DeleteContactAsync(this IWolfClient client, uint userID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 userID

ID of user to add.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
See Also
| Improve this Doc View Source

GetAchievementAsync(IWolfClient, WolfLanguage, UInt32, CancellationToken)

Retrieve achievement by ID.

Declaration
public static async Task<WolfAchievement> GetAchievementAsync(this IWolfClient client, WolfLanguage language, uint id, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
WolfLanguage language

Language to retrieve achievements in.
System.UInt32 id

ID of achievement to retrieve.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfAchievement>

Retrieved achievement.
Remarks

Achievement already cached will be retrieved from cache.

Due to the construction of the protocol, if achievement is not cached, the client will request all achievements again.

See Also
| Improve this Doc View Source

GetAchievementsAsync(IWolfClient, WolfLanguage, IEnumerable<UInt32>, CancellationToken)

Retrieve achievements by their IDs.

Declaration
public static async Task<IEnumerable<WolfAchievement>> GetAchievementsAsync(this IWolfClient client, WolfLanguage language, IEnumerable<uint> achievementIDs, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
WolfLanguage language

Language to retrieve achievements in.
System.Collections.Generic.IEnumerable<System.UInt32> achievementIDs

IDs of achievements to retrieve. Null or empty to get all achievements.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfAchievement>>

Enumerable of retrieved achievements.
Remarks

Achievements already cached will be retrieved from cache.

Due to the construction of the protocol, if any achievement is not cached, the client will request all achievements again.

All child achievements will be surfaced to the top level, so can be accessed by direct enumerable queries.

See Also
| Improve this Doc View Source

GetAllAchievementsAsync(IWolfClient, WolfLanguage, CancellationToken)

Retrieve all achievements.

Declaration
public static async Task<IEnumerable<WolfAchievement>> GetAllAchievementsAsync(this IWolfClient client, WolfLanguage language, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
WolfLanguage language

Language to retrieve achievements in.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfAchievement>>

Enumerable of retrieved achievements.
Remarks

This method skips cache completely, and all achievements will be downloaded from the server.

All child achievements will be surfaced to the top level, so can be accessed by direct enumerable queries.

See Also
| Improve this Doc View Source

GetAllCharmsAsync(IWolfClient, CancellationToken)

Retrieve all charms.

Declaration
public static Task<IEnumerable<WolfCharm>> GetAllCharmsAsync(this IWolfClient client, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfCharm>>

Enumerable of retrieved charms.
Remarks

Charms already cached will be retrieved from cache. Others will be requested from the server.

See Also
| Improve this Doc View Source

GetBlockedUsersAsync(IWolfClient, CancellationToken)

Get users blocked by current user.

Declaration
public static async Task<IEnumerable<WolfUser>> GetBlockedUsersAsync(this IWolfClient client, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfUser>>

Enumerable of profiles of blocked users.
Remarks

Users already cached will be retrieved from cache. Others will be requested from the server.

See Also
| Improve this Doc View Source

GetCharmAsync(IWolfClient, UInt32, CancellationToken)

Get charm by ID.

Declaration
public static async Task<WolfCharm> GetCharmAsync(this IWolfClient client, uint charmID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 charmID

ID of charm to retrieve.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfCharm>

Retrieved charm.
Remarks

If charm is already cached, cached instance will be returned. Otherwise a request to the server will be made.

See Also
| Improve this Doc View Source

GetCharmsAsync(IWolfClient, IEnumerable<UInt32>, CancellationToken)

Retrieve charms by their IDs.

Declaration
public static async Task<IEnumerable<WolfCharm>> GetCharmsAsync(this IWolfClient client, IEnumerable<uint> charmIDs, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.Collections.Generic.IEnumerable<System.UInt32> charmIDs

IDs of charms to retrieve.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfCharm>>

Enumerable of retrieved charms.
Remarks

Charms already cached will be retrieved from cache. Others will be requested from the server.

See Also
| Improve this Doc View Source

GetContactListAsync(IWolfClient, CancellationToken)

Get current user's contact list.

Declaration
public static async Task<IEnumerable<WolfUser>> GetContactListAsync(this IWolfClient client, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfUser>>

Enumerable of profiles of all contacts.
Remarks

Users already cached will be retrieved from cache. Others will be requested from the server.

See Also
| Improve this Doc View Source

GetCurrentUserAsync(IWolfClient, CancellationToken)

Get profile of currently logged in user.

Declaration
public static Task<WolfUser> GetCurrentUserAsync(this IWolfClient client, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfUser>

Currently logged in user.
Remarks

If user is already cached, cached instance will be returned. Otherwise a request to the server will be made.

Exceptions
Type Condition
System.InvalidOperationException

Not logged in.
See Also
| Improve this Doc View Source

GetCurrentUserGroupsAsync(IWolfClient, CancellationToken)

Retrieve profiles of groups current user is in.

Declaration
public static async Task<IEnumerable<WolfGroup>> GetCurrentUserGroupsAsync(this IWolfClient client, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfGroup>>

Enumerable of retrieved groups.
Remarks

Groups already cached will be retrieved from cache. Others will be requested from the server.

Groups will be retrieved with members list populated.

See Also
| Improve this Doc View Source

GetGroupAchievementsAsync(IWolfClient, UInt32, WolfLanguage, CancellationToken)

Retrieve groups's achievements.

Declaration
public static Task<IReadOnlyDictionary<WolfAchievement, DateTime?>> GetGroupAchievementsAsync(this IWolfClient client, uint groupID, WolfLanguage language, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 groupID

ID of group to retrieve achievements of.
WolfLanguage language

Language to retrieve achievements in.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyDictionary<WolfAchievement, System.Nullable<System.DateTime>>>

Dictionary of group achievements, with keys being achievement and value being unlock time.
Remarks

Achievements already cached will be retrieved from cache.

All child achievements will be surfaced to the top level, so can be accessed by direct enumerable queries.

See Also
| Improve this Doc View Source

GetGroupAsync(IWolfClient, String, CancellationToken)

Get profile of specified group.

Declaration
public static async Task<WolfGroup> GetGroupAsync(this IWolfClient client, string groupName, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.String groupName

ID of group to retrieve.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfGroup>

Retrieved group.
Remarks

If group is already cached, cached instance will be returned. Otherwise a request to the server will be made.

Group will be retrieved with members list populated.

See Also
| Improve this Doc View Source

GetGroupAsync(IWolfClient, UInt32, CancellationToken)

Get profile of specified group.

Declaration
public static async Task<WolfGroup> GetGroupAsync(this IWolfClient client, uint groupID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 groupID

ID of group to retrieve.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfGroup>

Retrieved group.
Remarks

If group is already cached, cached instance will be returned. Otherwise a request to the server will be made.

Group will be retrieved with members list populated.

See Also
| Improve this Doc View Source

GetGroupMessageHistoryAsync(IWolfClient, UInt32, Boolean, CancellationToken)

Retrieve group messages history, starting with most recent message.

Declaration
public static Task<IEnumerable<IChatMessage>> GetGroupMessageHistoryAsync(this IWolfClient client, uint groupID, bool oldestFirst, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 groupID

ID of group to get message history from.
System.Boolean oldestFirst

Whether to order retrieved messages from oldest to newest.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<IChatMessage>>

Enumerable of retrieved messages.
See Also
| Improve this Doc View Source

GetGroupMessageHistoryAsync(IWolfClient, UInt32, Nullable<WolfTimestamp>, Boolean, CancellationToken)

Retrieve group messages history.

Declaration
public static async Task<IEnumerable<IChatMessage>> GetGroupMessageHistoryAsync(this IWolfClient client, uint groupID, WolfTimestamp? beforeTime, bool oldestFirst, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 groupID

ID of group to get message history from.
System.Nullable<WolfTimestamp> beforeTime

Timestamp of oldest already retrieved message; null to retrieve from newest.
System.Boolean oldestFirst

Whether to order retrieved messages from oldest to newest.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<IChatMessage>>

Enumerable of retrieved messages.
See Also
| Improve this Doc View Source

GetGroupMessageHistoryAsync(IWolfClient, UInt32, Nullable<WolfTimestamp>, CancellationToken)

Retrieve group messages history, ordered from newest to oldest.

Declaration
public static Task<IEnumerable<IChatMessage>> GetGroupMessageHistoryAsync(this IWolfClient client, uint groupID, WolfTimestamp? beforeTime, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 groupID

ID of group to get message history from.
System.Nullable<WolfTimestamp> beforeTime

Timestamp of oldest already retrieved message; null to retrieve from newest.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<IChatMessage>>

Enumerable of retrieved messages.
See Also
| Improve this Doc View Source

GetGroupMessageHistoryAsync(IWolfClient, UInt32, CancellationToken)

Retrieve group messages history, ordered from newest to oldest, starting with most recent message.

Declaration
public static Task<IEnumerable<IChatMessage>> GetGroupMessageHistoryAsync(this IWolfClient client, uint groupID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 groupID

ID of group to get message history from.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<IChatMessage>>

Enumerable of retrieved messages.
See Also
| Improve this Doc View Source

GetGroupsAsync(IWolfClient, IEnumerable<UInt32>, CancellationToken)

Retrieve profiles of groups by their IDs.

Declaration
public static async Task<IEnumerable<WolfGroup>> GetGroupsAsync(this IWolfClient client, IEnumerable<uint> groupIDs, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.Collections.Generic.IEnumerable<System.UInt32> groupIDs

IDs of groups to retrieve.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfGroup>>

Enumerable of retrieved groups.
Remarks

Groups already cached will be retrieved from cache. Others will be requested from the server.

Groups will be retrieved with members list populated.

See Also
| Improve this Doc View Source

GetGroupStatisticsAsync(IWolfClient, UInt32, CancellationToken)

Gets statistics of a group.

Declaration
public static async Task<WolfGroupStatistics> GetGroupStatisticsAsync(this IWolfClient client, uint groupID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 groupID

ID of group to retrieve statistics for.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfGroupStatistics>

Retrieved group statistics.
See Also
| Improve this Doc View Source

GetLinkMetadataAsync(IWolfClient, String, CancellationToken)

Requests metadata of the link, as seen by WOLF servers.

Declaration
public static Task<UrlMetadataResponse> GetLinkMetadataAsync(this IWolfClient client, string url, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the message with.
System.String url

URL to get metadata of.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<UrlMetadataResponse>

Link metadata.
Exceptions
Type Condition
System.ArgumentNullException

URL is null.
System.ArgumentException

URL is empty, whitespace, or otherwise invalid.
| Improve this Doc View Source

GetMessageTipsDetailsAsync(IWolfClient, ChatMessage, CancellationToken)

Requests tips details for messages.

Declaration
public static async Task<IEnumerable<WolfTip>> GetMessageTipsDetailsAsync(this IWolfClient client, ChatMessage message, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
ChatMessage message

Message to get tips statistics for.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfTip>>

Collection of tips details.
| Improve this Doc View Source

GetMessageTipsSummaryAsync(IWolfClient, IEnumerable<ChatMessage>, CancellationToken)

Requests tips summaries for messages.

Declaration
public static async Task<IReadOnlyDictionary<WolfTimestamp, IEnumerable<WolfTip>>> GetMessageTipsSummaryAsync(this IWolfClient client, IEnumerable<ChatMessage> messages, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.Collections.Generic.IEnumerable<ChatMessage> messages

Messages to get tips statistics for.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyDictionary<WolfTimestamp, System.Collections.Generic.IEnumerable<WolfTip>>>

Dictionary, where key is message timestamp, and value is collection of its tips summaries.
| Improve this Doc View Source

GetMessageTipsSummaryAsync(IWolfClient, ChatMessage, CancellationToken)

Requests tips summaries for a message.

Declaration
public static async Task<IEnumerable<WolfTip>> GetMessageTipsSummaryAsync(this IWolfClient client, ChatMessage message, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
ChatMessage message

Message to get tips statistics for.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfTip>>

Collection of message's tips summaries.
| Improve this Doc View Source

GetMessageTipsSummaryAsync(IWolfClient, WolfTimestamp, UInt32, CancellationToken)

Requests tips summaries for a message.

Declaration
public static async Task<IEnumerable<WolfTip>> GetMessageTipsSummaryAsync(this IWolfClient client, WolfTimestamp messageTimestamp, uint groupID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
WolfTimestamp messageTimestamp

Timestamp of the message to get tips statistics for.
System.UInt32 groupID

ID of the group where the message was sent in.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfTip>>

Collection of message's tips summaries.
| Improve this Doc View Source

GetNotificationsAsync(IWolfClient, CancellationToken)

Get current user's notifications in English.

Declaration
public static Task<IEnumerable<WolfNotification>> GetNotificationsAsync(this IWolfClient client, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfNotification>>

Enumerable of retrieved notifications.
See Also
| Improve this Doc View Source

GetNotificationsAsync(IWolfClient, WolfLanguage, WolfDevice, CancellationToken)

Get current user's notifications.

Declaration
public static async Task<IEnumerable<WolfNotification>> GetNotificationsAsync(this IWolfClient client, WolfLanguage language, WolfDevice device, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
WolfLanguage language

Language to get notifications in.
WolfDevice device

Device to use.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfNotification>>

Enumerable of retrieved notifications.
See Also
| Improve this Doc View Source

GetPrivateMessageHistoryAsync(IWolfClient, UInt32, Boolean, CancellationToken)

Retrieve private messages history, starting with most recent message.

Declaration
public static Task<IEnumerable<IChatMessage>> GetPrivateMessageHistoryAsync(this IWolfClient client, uint userID, bool oldestFirst, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 userID

ID of user to get message history with.
System.Boolean oldestFirst

Whether to order retrieved messages from oldest to newest.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<IChatMessage>>

Enumerable of retrieved messages.
See Also
| Improve this Doc View Source

GetPrivateMessageHistoryAsync(IWolfClient, UInt32, Nullable<WolfTimestamp>, Boolean, CancellationToken)

Retrieve private messages history.

Declaration
public static async Task<IEnumerable<IChatMessage>> GetPrivateMessageHistoryAsync(this IWolfClient client, uint userID, WolfTimestamp? beforeTime, bool oldestFirst, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 userID

ID of user to get message history with.
System.Nullable<WolfTimestamp> beforeTime

Timestamp of oldest already retrieved message; null to retrieve from newest.
System.Boolean oldestFirst

Whether to order retrieved messages from oldest to newest.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<IChatMessage>>

Enumerable of retrieved messages.
See Also
| Improve this Doc View Source

GetPrivateMessageHistoryAsync(IWolfClient, UInt32, Nullable<WolfTimestamp>, CancellationToken)

Retrieve private messages history, ordered from newest to oldest.

Declaration
public static Task<IEnumerable<IChatMessage>> GetPrivateMessageHistoryAsync(this IWolfClient client, uint userID, WolfTimestamp? beforeTime, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 userID

ID of user to get message history with.
System.Nullable<WolfTimestamp> beforeTime

Timestamp of oldest already retrieved message; null to retrieve from newest.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<IChatMessage>>

Enumerable of retrieved messages.
See Also
| Improve this Doc View Source

GetPrivateMessageHistoryAsync(IWolfClient, UInt32, CancellationToken)

Retrieve private messages history, ordered from newest to oldest, starting with most recent message.

Declaration
public static Task<IEnumerable<IChatMessage>> GetPrivateMessageHistoryAsync(this IWolfClient client, uint userID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 userID

ID of user to get message history with.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<IChatMessage>>

Enumerable of retrieved messages.
See Also
| Improve this Doc View Source

GetRecentConversationsAsync(IWolfClient, CancellationToken)

Retrieve list of most recent messages.

Declaration
public static async Task<IEnumerable<IChatMessage>> GetRecentConversationsAsync(this IWolfClient client, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<IChatMessage>>

Enumerable with most recent messages.
| Improve this Doc View Source

GetUserAchievementsAsync(IWolfClient, UInt32, WolfLanguage, CancellationToken)

Retrieve user's achievements.

Declaration
public static Task<IReadOnlyDictionary<WolfAchievement, DateTime?>> GetUserAchievementsAsync(this IWolfClient client, uint userID, WolfLanguage language, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 userID

ID of user to retrieve achievements of.
WolfLanguage language

Language to retrieve achievements in.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyDictionary<WolfAchievement, System.Nullable<System.DateTime>>>

Dictionary of user achievements, with keys being achievement and value being unlock time.
Remarks

Achievements already cached will be retrieved from cache.

All child achievements will be surfaced to the top level, so can be accessed by direct enumerable queries.

See Also
| Improve this Doc View Source

GetUserActiveCharmsAsync(IWolfClient, UInt32, CancellationToken)

Get user's currently owned charms.

Declaration
public static async Task<IEnumerable<WolfCharmSubscription>> GetUserActiveCharmsAsync(this IWolfClient client, uint userID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 userID

ID of user to retrieve owned charms of.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfCharmSubscription>>

Enumerable of owned charms subscriptions.
See Also
| Improve this Doc View Source

GetUserAsync(IWolfClient, UInt32, CancellationToken)

Get profile of specified user.

Declaration
public static async Task<WolfUser> GetUserAsync(this IWolfClient client, uint userID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 userID

ID of user to retrieve.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfUser>

Retrieved user.
Remarks

If user is already cached, cached instance will be returned. Otherwise a request to the server will be made.

See Also
| Improve this Doc View Source

GetUserCharmStatsAsync(IWolfClient, UInt32, CancellationToken)

Get user's charm statistics.

Declaration
public static Task<CharmStatisticsResponse> GetUserCharmStatsAsync(this IWolfClient client, uint userID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 userID

ID of user to retrieve charm statistics of.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<CharmStatisticsResponse>

User's charm statistics.
See Also
| Improve this Doc View Source

GetUserCurrentCharmAsync(IWolfClient, UInt32, CancellationToken)

Get user's selected charm.

Declaration
public static async Task<WolfCharm> GetUserCurrentCharmAsync(this IWolfClient client, uint userID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 userID

ID of user to retrieve selected charm of.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfCharm>

User's currently selected charm.
Remarks

If charm is already cached, cached instance will be returned. Otherwise a request to the server will be made.

If user is already cached, cached instance will be returned. Otherwise a request to the server will be made.

See Also
| Improve this Doc View Source

GetUserExpiredCharmsAsync(IWolfClient, UInt32, CancellationToken)

Get user's expired charms.

Declaration
public static async Task<IEnumerable<WolfCharmSubscription>> GetUserExpiredCharmsAsync(this IWolfClient client, uint userID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 userID

ID of user to retrieve expired charms of.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfCharmSubscription>>

Enumerable of expired charms subscriptions.
See Also
| Improve this Doc View Source

GetUsersAsync(IWolfClient, IEnumerable<UInt32>, CancellationToken)

Retrieve profiles of users by their IDs.

Declaration
public static async Task<IEnumerable<WolfUser>> GetUsersAsync(this IWolfClient client, IEnumerable<uint> userIDs, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.Collections.Generic.IEnumerable<System.UInt32> userIDs

IDs of users to retrieve.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<WolfUser>>

Enumerable of retrieved users.
Remarks

Users already cached will be retrieved from cache. Others will be requested from the server.

See Also
| Improve this Doc View Source

JoinGroupAsync(IWolfClient, String, String, CancellationToken)

Join group.

Declaration
public static async Task<WolfGroup> JoinGroupAsync(this IWolfClient client, string groupName, string password, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.String groupName

ID of the group to join.
System.String password

Password to use when joining.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfGroup>

Joined group's profile.
See Also
| Improve this Doc View Source

JoinGroupAsync(IWolfClient, String, CancellationToken)

Join a group.

Declaration
public static Task<WolfGroup> JoinGroupAsync(this IWolfClient client, string groupName, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.String groupName

Name of the group to join.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfGroup>

Joined group's profile.
See Also
| Improve this Doc View Source

JoinGroupAsync(IWolfClient, UInt32, String, CancellationToken)

Join a group.

Declaration
public static async Task<WolfGroup> JoinGroupAsync(this IWolfClient client, uint groupID, string password, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 groupID

ID of group to join.
System.String password

Password to use when joining.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfGroup>

Joined group's profile.
See Also
| Improve this Doc View Source

JoinGroupAsync(IWolfClient, UInt32, CancellationToken)

Join a group.

Declaration
public static Task<WolfGroup> JoinGroupAsync(this IWolfClient client, uint groupID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 groupID

ID of group to join.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfGroup>

Joined group's profile.
See Also
| Improve this Doc View Source

KickUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)

Kick a group member.

Declaration
public static Task KickUserAsync(this IWolfClient client, uint userID, uint groupID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to perform the admin action with.
System.UInt32 userID

User ID of group member to kick.
System.UInt32 groupID

ID of group to kick the user from.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
See Also
| Improve this Doc View Source

LeaveGroupAsync(IWolfClient, UInt32, CancellationToken)

Leave a group.

Declaration
public static Task LeaveGroupAsync(this IWolfClient client, uint groupID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 groupID

ID of group to leave.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
See Also
| Improve this Doc View Source

LoginAsync(IWolfClient, String, String, CancellationToken)

Log in, using Email login type.

Declaration
public static Task<LoginResponse> LoginAsync(this IWolfClient client, string login, string password, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

The client to login with.
System.String login

User email to use to login with.
System.String password

User password.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel logging in.
Returns
Type Description
System.Threading.Tasks.Task<LoginResponse>

Response with login result.
See Also
| Improve this Doc View Source

LoginAsync(IWolfClient, String, String, WolfLoginType, CancellationToken)

Log in.

Declaration
public static Task<LoginResponse> LoginAsync(this IWolfClient client, string login, string password, WolfLoginType loginType, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

The client to login with.
System.String login

User email to use to login with.
System.String password

User password.
WolfLoginType loginType

Login type to use.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel logging in.
Returns
Type Description
System.Threading.Tasks.Task<LoginResponse>

Response with login result.
See Also
| Improve this Doc View Source

LogoutAsync(IWolfClient, CancellationToken)

Log out.

Declaration
public static Task LogoutAsync(this IWolfClient client, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task
See Also
| Improve this Doc View Source

ModUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)

Mod a group member.

Declaration
public static Task ModUserAsync(this IWolfClient client, uint userID, uint groupID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to perform the admin action with.
System.UInt32 userID

User ID of group member to mod.
System.UInt32 groupID

ID of group to mod the user in.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
See Also
| Improve this Doc View Source

RemoveActiveCharmAsync(IWolfClient, CancellationToken)

Remove current user's selected charm.

Declaration
public static Task RemoveActiveCharmAsync(this IWolfClient client, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
See Also
| Improve this Doc View Source

ReplyImageAsync(IWolfClient, ChatMessage, IEnumerable<Byte>, CancellationToken)

Sends an image response message to group or user.

Declaration
public static Task<ChatResponse> ReplyImageAsync(this IWolfClient client, ChatMessage incomingMessage, IEnumerable<byte> imageBytes, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the message with.
ChatMessage incomingMessage

Message the user or group sent to the client.
System.Collections.Generic.IEnumerable<System.Byte> imageBytes

Bytes of the image to send.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<ChatResponse>

Message sending response.
| Improve this Doc View Source

ReplyTextAsync(IWolfClient, ChatMessage, String, CancellationToken)

Sends a text message response message to group or user.

Declaration
public static Task<ChatResponse> ReplyTextAsync(this IWolfClient client, ChatMessage incomingMessage, string text, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the message with.
ChatMessage incomingMessage

Message the user or group sent to the client.
System.String text

Content of the message.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<ChatResponse>

Message sending response.
| Improve this Doc View Source

ReplyVoiceAsync(IWolfClient, ChatMessage, IEnumerable<Byte>, CancellationToken)

Sends a voice response message to group or user.

Declaration
public static Task<ChatResponse> ReplyVoiceAsync(this IWolfClient client, ChatMessage incomingMessage, IEnumerable<byte> voiceBytes, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the message with.
ChatMessage incomingMessage

Message the user or group sent to the client.
System.Collections.Generic.IEnumerable<System.Byte> voiceBytes

Bytes of the voice to send.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<ChatResponse>

Message sending response.
| Improve this Doc View Source

ResetUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)

Reset a group member.

Declaration
public static Task ResetUserAsync(this IWolfClient client, uint userID, uint groupID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to perform the admin action with.
System.UInt32 userID

User ID of group member to reset.
System.UInt32 groupID

ID of group to reset the user in.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
See Also
| Improve this Doc View Source

RestoreChatMessageAsync(IWolfClient, ChatMessage, CancellationToken)

Requests chat message to be restored (un-deleted).

Declaration
public static Task<ChatUpdateResponse> RestoreChatMessageAsync(this IWolfClient client, ChatMessage message, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the message with.
ChatMessage message

Chat message to restore.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<ChatUpdateResponse>

Message updating result.
| Improve this Doc View Source

SendGroupImageMessageAsync(IWolfClient, UInt32, IEnumerable<Byte>, CancellationToken)

Sends a group image message.

Declaration
public static Task<ChatResponse> SendGroupImageMessageAsync(this IWolfClient client, uint groupID, IEnumerable<byte> imageBytes, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the message with.
System.UInt32 groupID

ID of group to send the message to.
System.Collections.Generic.IEnumerable<System.Byte> imageBytes

Bytes of the image to send.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<ChatResponse>

Message sending response.
| Improve this Doc View Source

SendGroupTextMessageAsync(IWolfClient, UInt32, String, CancellationToken)

Sends a group text message.

Declaration
public static Task<ChatResponse> SendGroupTextMessageAsync(this IWolfClient client, uint groupID, string text, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the message with.
System.UInt32 groupID

ID of group to send the message to.
System.String text

Content of the message.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<ChatResponse>

Message sending response.
| Improve this Doc View Source

SendGroupTextMessageAsync(IWolfClient, UInt32, String, ChatMessageSendingOptions, CancellationToken)

Sends a group text message.

Declaration
public static async Task<ChatResponse> SendGroupTextMessageAsync(this IWolfClient client, uint groupID, string text, ChatMessageSendingOptions options, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the message with.
System.UInt32 groupID

ID of group to send the message to.
System.String text

Content of the message.
ChatMessageSendingOptions options

Options configuring how the message should get pre-processed.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<ChatResponse>

Message sending response.
| Improve this Doc View Source

SendGroupVoiceMessageAsync(IWolfClient, UInt32, IEnumerable<Byte>, CancellationToken)

Sends a group voice message.

Declaration
public static Task<ChatResponse> SendGroupVoiceMessageAsync(this IWolfClient client, uint groupID, IEnumerable<byte> voiceBytes, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the message with.
System.UInt32 groupID

ID of group to send the message to.
System.Collections.Generic.IEnumerable<System.Byte> voiceBytes

Bytes of the voice to send.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<ChatResponse>

Message sending response.
| Improve this Doc View Source

SendPrivateImageMessageAsync(IWolfClient, UInt32, IEnumerable<Byte>, CancellationToken)

Sends a private image message.

Declaration
public static Task<ChatResponse> SendPrivateImageMessageAsync(this IWolfClient client, uint userID, IEnumerable<byte> imageBytes, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the message with.
System.UInt32 userID

ID of user to send the message to.
System.Collections.Generic.IEnumerable<System.Byte> imageBytes

Bytes of the image to send.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<ChatResponse>

Message sending response.
| Improve this Doc View Source

SendPrivateTextMessageAsync(IWolfClient, UInt32, String, CancellationToken)

Sends a private text message.

Declaration
public static Task<ChatResponse> SendPrivateTextMessageAsync(this IWolfClient client, uint userID, string text, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the message with.
System.UInt32 userID

ID of user to send the message to.
System.String text

Content of the message.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<ChatResponse>

Message sending response.
| Improve this Doc View Source

SendPrivateTextMessageAsync(IWolfClient, UInt32, String, ChatMessageSendingOptions, CancellationToken)

Sends a private text message.

Declaration
public static async Task<ChatResponse> SendPrivateTextMessageAsync(this IWolfClient client, uint userID, string text, ChatMessageSendingOptions options, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the message with.
System.UInt32 userID

ID of user to send the message to.
System.String text

Content of the message.
ChatMessageSendingOptions options

Options configuring how the message should get pre-processed.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<ChatResponse>

Message sending response.
| Improve this Doc View Source

SendPrivateVoiceMessageAsync(IWolfClient, UInt32, IEnumerable<Byte>, CancellationToken)

Sends a private voice message.

Declaration
public static Task<ChatResponse> SendPrivateVoiceMessageAsync(this IWolfClient client, uint userID, IEnumerable<byte> voiceBytes, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the message with.
System.UInt32 userID

ID of user to send the message to.
System.Collections.Generic.IEnumerable<System.Byte> voiceBytes

Bytes of the voice to send.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<ChatResponse>

Message sending response.
| Improve this Doc View Source

SetActiveCharmAsync(IWolfClient, UInt32, CancellationToken)

Set current user's selected charm.

Declaration
public static Task SetActiveCharmAsync(this IWolfClient client, uint charmID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 charmID

ID of charm to set as active.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
See Also
| Improve this Doc View Source

SetOnlineStateAsync(IWolfClient, WolfOnlineState, CancellationToken)

Update current user's online state.

Declaration
public static Task SetOnlineStateAsync(this IWolfClient client, WolfOnlineState state, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to set online state of.
WolfOnlineState state

Online state to set.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SilenceUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)

Silence a group member.

Declaration
public static Task SilenceUserAsync(this IWolfClient client, uint userID, uint groupID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to perform the admin action with.
System.UInt32 userID

User ID of group member to silence.
System.UInt32 groupID

ID of group to silence the user in.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
See Also
| Improve this Doc View Source

SubscribeAllMessagesAsync(IWolfClient, CancellationToken)

Subscribes to all incoming messages.

Declaration
public static Task SubscribeAllMessagesAsync(this IWolfClient client, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client that subscribes to messages.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel subscribing.
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

SubscribeGroupMessagesAsync(IWolfClient, CancellationToken)

Subscribes to incoming group message.

Declaration
public static async Task<IReadOnlyDictionary<uint, HttpStatusCode>> SubscribeGroupMessagesAsync(this IWolfClient client, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client that subscribes to messages.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel subscribing.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyDictionary<System.UInt32, System.Net.HttpStatusCode>>
| Improve this Doc View Source

SubscribeGroupTipsAsync(IWolfClient, CancellationToken)

Subscribes to message tips notifications.

Declaration
public static async Task<IReadOnlyDictionary<uint, HttpStatusCode>> SubscribeGroupTipsAsync(this IWolfClient client, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client that subscribes to tips.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel subscribing.
Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyDictionary<System.UInt32, System.Net.HttpStatusCode>>
| Improve this Doc View Source

SubscribePrivateMessagesAsync(IWolfClient, CancellationToken)

Subscribes to incoming private message.

Declaration
public static Task SubscribePrivateMessagesAsync(this IWolfClient client, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client that subscribes to messages.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel subscribing.
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

TipMessageAsync(IWolfClient, ChatMessage, IEnumerable<UInt32>, CancellationToken)

Tips a message.

Declaration
public static Task TipMessageAsync(this IWolfClient client, ChatMessage message, IEnumerable<uint> charmIDs, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
ChatMessage message

Message to tip.
System.Collections.Generic.IEnumerable<System.UInt32> charmIDs

IDs of charms to tip the message with.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

TipMessageAsync(IWolfClient, ChatMessage, IEnumerable<WolfTip>, CancellationToken)

Tips a message.

Declaration
public static Task TipMessageAsync(this IWolfClient client, ChatMessage message, IEnumerable<WolfTip> tips, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
ChatMessage message

Message to tip.
System.Collections.Generic.IEnumerable<WolfTip> tips

Tips to tip the message with.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

TipMessageAsync(IWolfClient, ChatMessage, UInt32, CancellationToken)

Tips a message.

Declaration
public static Task TipMessageAsync(this IWolfClient client, ChatMessage message, uint charmID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
ChatMessage message

Message to tip.
System.UInt32 charmID

ID of charm to tip the message with.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

TipMessageAsync(IWolfClient, ChatMessage, WolfTip, CancellationToken)

Tips a message.

Declaration
public static Task TipMessageAsync(this IWolfClient client, ChatMessage message, WolfTip tip, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
ChatMessage message

Message to tip.
WolfTip tip

Tip to tip the message with.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

UnblockUserAsync(IWolfClient, UInt32, CancellationToken)

Unblock user.

Declaration
public static Task UnblockUserAsync(this IWolfClient client, uint userID, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 userID

ID of user to block.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task
See Also
| Improve this Doc View Source

UpdateGroupAsync(IWolfClient, UInt32, Action<GroupUpdateMessage.Builder>, CancellationToken)

Updates group profile.

Declaration
public static async Task<WolfGroup> UpdateGroupAsync(this IWolfClient client, uint groupID, Action<GroupUpdateMessage.Builder> updates, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 groupID

ID of group to update.
System.Action<GroupUpdateMessage.Builder> updates

Group profile changes to apply.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfGroup>

Profile of updated group.
See Also
| Improve this Doc View Source

UpdateGroupAudioConfigAsync(IWolfClient, UInt32, Action<GroupAudioUpdateMessage.Builder>, CancellationToken)

Updates group audio configuration.

Declaration
public static async Task<WolfGroup.WolfGroupAudioConfig> UpdateGroupAudioConfigAsync(this IWolfClient client, uint groupID, Action<GroupAudioUpdateMessage.Builder> updates, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.UInt32 groupID

ID of group to update.
System.Action<GroupAudioUpdateMessage.Builder> updates

Group audio configuration changes to apply.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfGroup.WolfGroupAudioConfig>

Updated audio configuration.
See Also
| Improve this Doc View Source

UpdateNicknameAsync(IWolfClient, String, CancellationToken)

Update current user's nickname.

Declaration
public static Task<WolfUser> UpdateNicknameAsync(this IWolfClient client, string newNickname, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.String newNickname

Nickname to set.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfUser>

Updated current user.
See Also
| Improve this Doc View Source

UpdateProfileAsync(IWolfClient, Action<UserUpdateMessage.Builder>, CancellationToken)

Update current user's profile.

Declaration
public static async Task<WolfUser> UpdateProfileAsync(this IWolfClient client, Action<UserUpdateMessage.Builder> updates, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.Action<UserUpdateMessage.Builder> updates

Profile changes to apply.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfUser>

Updated current user.
See Also
| Improve this Doc View Source

UpdateStatusAsync(IWolfClient, String, CancellationToken)

Update current user's status.

Declaration
public static Task<WolfUser> UpdateStatusAsync(this IWolfClient client, string newStatus, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
IWolfClient client

Client to send the request with.
System.String newStatus

Status to set.
System.Threading.CancellationToken cancellationToken

Cancellation token that can cancel the task.
Returns
Type Description
System.Threading.Tasks.Task<WolfUser>

Updated current user.
See Also