Interface IWolfClient

A Wolf client.

Namespace: TehGM.Wolfringo
Assembly: Wolfringo.Core.dll
Syntax
public interface IWolfClient

Properties

| Improve this Doc View Source

CurrentUserID

Currently logged in user. Null if not connected.

Declaration
uint? CurrentUserID { get; }
Property Value
Type Description
System.Nullable<System.UInt32>

Methods

| Improve this Doc View Source

AddMessageListener(IMessageCallback)

Adds event listener.

Declaration
void AddMessageListener(IMessageCallback listener)
Parameters
Type Name Description
IMessageCallback listener

Callback to invoke on event.
| Improve this Doc View Source

ConnectAsync(CancellationToken)

Connects to the server.

Declaration
Task ConnectAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken

Token to abort entire connection.
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

DisconnectAsync(CancellationToken)

Disconnects from the server.

Declaration
Task DisconnectAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

RemoveMessageListener(IMessageCallback)

Removes event listener.

Declaration
void RemoveMessageListener(IMessageCallback listener)
Parameters
Type Name Description
IMessageCallback listener

Callback to remove.
| Improve this Doc View Source

SendAsync<TResponse>(IWolfMessage, CancellationToken)

Sends message, and waits for response from the server.

Declaration
Task<TResponse> SendAsync<TResponse>(IWolfMessage message, CancellationToken cancellationToken = default(CancellationToken))
    where TResponse : IWolfResponse
Parameters
Type Name Description
IWolfMessage message

Message to send.
System.Threading.CancellationToken cancellationToken

Cancellation token that can be used for Task cancellation.
Returns
Type Description
System.Threading.Tasks.Task<TResponse>

Sending response.
Type Parameters
Name Description
TResponse

Response type to use for casting of response.
Remarks

If client uses ResponseTypeResolver, the type of response provided with ResponseTypeAttribute on message will be used for deserialization, and TResponse will be used only for casting. If ResponseTypeAttribute is not set on message, TResponse will be used for deserialization as normal.

Exceptions
Type Condition
MessageSendingException

Server responded with error.

Events

| Improve this Doc View Source

Connected

Rasied when the client connects to the server.

Declaration
event EventHandler Connected
Event Type
Type Description
System.EventHandler
| Improve this Doc View Source

Disconnected

Raised when the client disconnects from the server.

Declaration
event EventHandler Disconnected
Event Type
Type Description
System.EventHandler
| Improve this Doc View Source

ErrorRaised

Raised when an error has occured.

Declaration
event EventHandler<UnhandledExceptionEventArgs> ErrorRaised
Event Type
Type Description
System.EventHandler<System.UnhandledExceptionEventArgs>
| Improve this Doc View Source

MessageReceived

Raised when the client receives an event from the server.

Declaration
event EventHandler<WolfMessageEventArgs> MessageReceived
Event Type
Type Description
System.EventHandler<WolfMessageEventArgs>
| Improve this Doc View Source

MessageSent

Raised when the client sends a message to the server.

Declaration
event EventHandler<WolfMessageSentEventArgs> MessageSent
Event Type
Type Description
System.EventHandler<WolfMessageSentEventArgs>

Extension Methods

InteractiveExtensions.AwaitNextAsync<T>(IWolfClient, Func<T, Boolean>, CancellationToken)
InteractiveExtensions.AwaitNextPrivateByUserAsync(IWolfClient, UInt32, CancellationToken)
InteractiveExtensions.AwaitNextGroupByUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)
InteractiveExtensions.AwaitNextInGroupAsync(IWolfClient, UInt32, CancellationToken)
InteractiveExtensions.AwaitNextAsync<T>(IWolfClient, Func<T, Boolean>, TimeSpan, CancellationToken)
InteractiveExtensions.AwaitNextPrivateByUserAsync(IWolfClient, UInt32, TimeSpan, CancellationToken)
InteractiveExtensions.AwaitNextGroupByUserAsync(IWolfClient, UInt32, UInt32, TimeSpan, CancellationToken)
InteractiveExtensions.AwaitNextInGroupAsync(IWolfClient, UInt32, TimeSpan, CancellationToken)
Sender.LoginAsync(IWolfClient, String, String, WolfLoginType, CancellationToken)
Sender.LoginAsync(IWolfClient, String, String, CancellationToken)
Sender.LogoutAsync(IWolfClient, CancellationToken)
Sender.SubscribeAllMessagesAsync(IWolfClient, CancellationToken)
Sender.SubscribePrivateMessagesAsync(IWolfClient, CancellationToken)
Sender.SubscribeGroupMessagesAsync(IWolfClient, CancellationToken)
Sender.SubscribeGroupTipsAsync(IWolfClient, CancellationToken)
Sender.SetOnlineStateAsync(IWolfClient, WolfOnlineState, CancellationToken)
Sender.GetNotificationsAsync(IWolfClient, WolfLanguage, WolfDevice, CancellationToken)
Sender.GetNotificationsAsync(IWolfClient, CancellationToken)
Sender.ClearNotificationsAsync(IWolfClient, CancellationToken)
Sender.GetUsersAsync(IWolfClient, IEnumerable<UInt32>, CancellationToken)
Sender.GetCurrentUserAsync(IWolfClient, CancellationToken)
Sender.GetUserAsync(IWolfClient, UInt32, CancellationToken)
Sender.GetContactListAsync(IWolfClient, CancellationToken)
Sender.AddContactAsync(IWolfClient, UInt32, CancellationToken)
Sender.DeleteContactAsync(IWolfClient, UInt32, CancellationToken)
Sender.GetBlockedUsersAsync(IWolfClient, CancellationToken)
Sender.BlockUserAsync(IWolfClient, UInt32, CancellationToken)
Sender.UnblockUserAsync(IWolfClient, UInt32, CancellationToken)
Sender.UpdateProfileAsync(IWolfClient, Action<UserUpdateMessage.Builder>, CancellationToken)
Sender.UpdateNicknameAsync(IWolfClient, String, CancellationToken)
Sender.UpdateStatusAsync(IWolfClient, String, CancellationToken)
Sender.GetPrivateMessageHistoryAsync(IWolfClient, UInt32, Nullable<WolfTimestamp>, Boolean, CancellationToken)
Sender.GetPrivateMessageHistoryAsync(IWolfClient, UInt32, Nullable<WolfTimestamp>, CancellationToken)
Sender.GetPrivateMessageHistoryAsync(IWolfClient, UInt32, Boolean, CancellationToken)
Sender.GetPrivateMessageHistoryAsync(IWolfClient, UInt32, CancellationToken)
Sender.GetGroupMessageHistoryAsync(IWolfClient, UInt32, Nullable<WolfTimestamp>, Boolean, CancellationToken)
Sender.GetGroupMessageHistoryAsync(IWolfClient, UInt32, Nullable<WolfTimestamp>, CancellationToken)
Sender.GetGroupMessageHistoryAsync(IWolfClient, UInt32, Boolean, CancellationToken)
Sender.GetGroupMessageHistoryAsync(IWolfClient, UInt32, CancellationToken)
Sender.GetRecentConversationsAsync(IWolfClient, CancellationToken)
Sender.JoinGroupAsync(IWolfClient, UInt32, String, CancellationToken)
Sender.JoinGroupAsync(IWolfClient, UInt32, CancellationToken)
Sender.JoinGroupAsync(IWolfClient, String, String, CancellationToken)
Sender.JoinGroupAsync(IWolfClient, String, CancellationToken)
Sender.LeaveGroupAsync(IWolfClient, UInt32, CancellationToken)
Sender.GetGroupsAsync(IWolfClient, IEnumerable<UInt32>, CancellationToken)
Sender.GetGroupAsync(IWolfClient, UInt32, CancellationToken)
Sender.GetGroupAsync(IWolfClient, String, CancellationToken)
Sender.GetCurrentUserGroupsAsync(IWolfClient, CancellationToken)
Sender.GetGroupStatisticsAsync(IWolfClient, UInt32, CancellationToken)
Sender.CreateGroupAsync(IWolfClient, String, String, Action<GroupCreateMessage.Builder>, CancellationToken)
Sender.CreateGroupAsync(IWolfClient, String, String, CancellationToken)
Sender.UpdateGroupAsync(IWolfClient, UInt32, Action<GroupUpdateMessage.Builder>, CancellationToken)
Sender.UpdateGroupAudioConfigAsync(IWolfClient, UInt32, Action<GroupAudioUpdateMessage.Builder>, CancellationToken)
Sender.GetCharmsAsync(IWolfClient, IEnumerable<UInt32>, CancellationToken)
Sender.GetAllCharmsAsync(IWolfClient, CancellationToken)
Sender.GetCharmAsync(IWolfClient, UInt32, CancellationToken)
Sender.GetUserCharmStatsAsync(IWolfClient, UInt32, CancellationToken)
Sender.GetUserCurrentCharmAsync(IWolfClient, UInt32, CancellationToken)
Sender.GetUserActiveCharmsAsync(IWolfClient, UInt32, CancellationToken)
Sender.GetUserExpiredCharmsAsync(IWolfClient, UInt32, CancellationToken)
Sender.SetActiveCharmAsync(IWolfClient, UInt32, CancellationToken)
Sender.RemoveActiveCharmAsync(IWolfClient, CancellationToken)
Sender.GetAchievementsAsync(IWolfClient, WolfLanguage, IEnumerable<UInt32>, CancellationToken)
Sender.GetAchievementAsync(IWolfClient, WolfLanguage, UInt32, CancellationToken)
Sender.GetAllAchievementsAsync(IWolfClient, WolfLanguage, CancellationToken)
Sender.GetUserAchievementsAsync(IWolfClient, UInt32, WolfLanguage, CancellationToken)
Sender.GetGroupAchievementsAsync(IWolfClient, UInt32, WolfLanguage, CancellationToken)
Sender.AdminUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)
Sender.ModUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)
Sender.ResetUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)
Sender.SilenceUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)
Sender.KickUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)
Sender.BanUserAsync(IWolfClient, UInt32, UInt32, CancellationToken)
Sender.SendPrivateTextMessageAsync(IWolfClient, UInt32, String, CancellationToken)
Sender.SendGroupTextMessageAsync(IWolfClient, UInt32, String, CancellationToken)
Sender.SendPrivateTextMessageAsync(IWolfClient, UInt32, String, ChatMessageSendingOptions, CancellationToken)
Sender.SendGroupTextMessageAsync(IWolfClient, UInt32, String, ChatMessageSendingOptions, CancellationToken)
Sender.SendPrivateImageMessageAsync(IWolfClient, UInt32, IEnumerable<Byte>, CancellationToken)
Sender.SendGroupImageMessageAsync(IWolfClient, UInt32, IEnumerable<Byte>, CancellationToken)
Sender.SendPrivateVoiceMessageAsync(IWolfClient, UInt32, IEnumerable<Byte>, CancellationToken)
Sender.SendGroupVoiceMessageAsync(IWolfClient, UInt32, IEnumerable<Byte>, CancellationToken)
Sender.ReplyTextAsync(IWolfClient, ChatMessage, String, CancellationToken)
Sender.ReplyImageAsync(IWolfClient, ChatMessage, IEnumerable<Byte>, CancellationToken)
Sender.ReplyVoiceAsync(IWolfClient, ChatMessage, IEnumerable<Byte>, CancellationToken)
Sender.DeleteChatMessageAsync(IWolfClient, ChatMessage, CancellationToken)
Sender.RestoreChatMessageAsync(IWolfClient, ChatMessage, CancellationToken)
Sender.GetLinkMetadataAsync(IWolfClient, String, CancellationToken)
Sender.GetMessageTipsSummaryAsync(IWolfClient, WolfTimestamp, UInt32, CancellationToken)
Sender.GetMessageTipsSummaryAsync(IWolfClient, IEnumerable<ChatMessage>, CancellationToken)
Sender.GetMessageTipsSummaryAsync(IWolfClient, ChatMessage, CancellationToken)
Sender.GetMessageTipsDetailsAsync(IWolfClient, ChatMessage, CancellationToken)
Sender.TipMessageAsync(IWolfClient, ChatMessage, UInt32, CancellationToken)
Sender.TipMessageAsync(IWolfClient, ChatMessage, IEnumerable<UInt32>, CancellationToken)
Sender.TipMessageAsync(IWolfClient, ChatMessage, WolfTip, CancellationToken)
Sender.TipMessageAsync(IWolfClient, ChatMessage, IEnumerable<WolfTip>, CancellationToken)
WolfClientExtensions.SendAsync(IWolfClient, IWolfMessage, CancellationToken)
WolfClientExtensions.AddMessageListener<T>(IWolfClient, Action<T>)
WolfClientExtensions.AddMessageListener<T>(IWolfClient, String, Action<T>)
WolfClientExtensions.RemoveMessageListener<T>(IWolfClient, Action<T>)
WolfGroupMembersHelper.RevalidateGroupMembersAsync(IWolfClient, WolfGroup, CancellationToken)