Class LoginMessage

A message for logging in.

Inheritance
System.Object
LoginMessage
Implements
Namespace: TehGM.Wolfringo.Messages
Assembly: Wolfringo.Core.dll
Syntax
[ResponseType(typeof(LoginResponse))]
public class LoginMessage : IHeadersWolfMessage, IWolfMessage
Remarks

Uses LoginResponse as response type.

Constructors

| Improve this Doc View Source

LoginMessage()

Creates a message instance.

Declaration
[JsonConstructor]
protected LoginMessage()
| Improve this Doc View Source

LoginMessage(String, String, WolfLoginType)

Creates a message instance.

Declaration
public LoginMessage(string login, string password, WolfLoginType loginType)
Parameters
Type Name Description
System.String login

Email to login with.
System.String password

Password to use when logging in.
WolfLoginType loginType

Type of login to perform.

Properties

| Improve this Doc View Source

EventName

Message event name.

Declaration
[JsonIgnore]
public string EventName { get; }
Property Value
Type Description
System.String
Remarks

Equals to SecurityLogin.

| Improve this Doc View Source

Headers

Message payload headers.

Declaration
[JsonIgnore]
public IDictionary<string, object> Headers { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>
| Improve this Doc View Source

Login

Login email.

Declaration
[JsonProperty("username", Required = Required.Always)]
public string Login { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

LoginType

Login type to use.

Declaration
[JsonIgnore]
public WolfLoginType LoginType { get; }
Property Value
Type Description
WolfLoginType
| Improve this Doc View Source

Password

Login password.

Declaration
[JsonProperty("password", Required = Required.Always)]
public string Password { get; }
Property Value
Type Description
System.String
Remarks

The password might be hashed. Check UseMD5 to see if password is hashed.

| Improve this Doc View Source

UseMD5

Whether the password is hashed.

Declaration
[JsonProperty("md5Password")]
public bool UseMD5 { get; }
Property Value
Type Description
System.Boolean
Remarks

Current implementation will hash passwords only when LoginType is Email.

Methods

| Improve this Doc View Source

LoginTypeToString(WolfLoginType)

Converts WolfLoginType to its string representation that is recognized by WOLF protocol.

Declaration
public static string LoginTypeToString(WolfLoginType loginType)
Parameters
Type Name Description
WolfLoginType loginType

Login type to convert to string.
Returns
Type Description
System.String

String representation.

Implements

IHeadersWolfMessage
IWolfMessage

Extension Methods

SerializationHelper.SerializeJsonPayload<T>(T, JsonSerializer)