Wolfringo Wolfringo
Wolfringo Wolfringo
Wolfringo (c) 2020 TehGM
DocFX, DiscordFX theme.
Search Results for

    Class SubscribeToGroupMessage

    A message for subscribing to group messages.

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

    Uses EntitiesSubscribeResponse as response type.

    Constructors

    | Improve this Doc View Source

    SubscribeToGroupMessage()

    Creates a message instance.

    Declaration
    [JsonConstructor]
    public SubscribeToGroupMessage()
    | Improve this Doc View Source

    SubscribeToGroupMessage(Nullable<UInt32>)

    Creates a message instance.

    Declaration
    public SubscribeToGroupMessage(uint? groupID)
    Parameters
    Type Name Description
    System.Nullable<System.UInt32> groupID

    ID of the group to subscribe to. Use null to subscribe to all.

    Remarks

    When groupID is null, the request will subscribe to messages from all groups.

    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 MessageGroupSubscribe.

    | Improve this Doc View Source

    GroupID

    ID of the group.

    Declaration
    [JsonProperty("id", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
    public uint? GroupID { get; }
    Property Value
    Type Description
    System.Nullable<System.UInt32>
    Remarks

    When this value is null, request will subscribe to messages from all groups.

    | 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>

    Implements

    IHeadersWolfMessage
    IWolfMessage

    Extension Methods

    SerializationHelper.SerializeJsonPayload<T>(T, JsonSerializer)