Class SubscribeToGroupMessage
A message for subscribing to group messages.
Namespace: TehGM.Wolfringo.Messages
Assembly: Wolfringo.Core.dll
Syntax
[ResponseType(typeof(EntitiesSubscribeResponse))]
public class SubscribeToGroupMessage : IHeadersWolfMessage, IWolfMessageRemarks
Uses EntitiesSubscribeResponse as response type.
Constructors
| Improve this Doc View SourceSubscribeToGroupMessage()
Creates a message instance.
Declaration
[JsonConstructor]
public SubscribeToGroupMessage()SubscribeToGroupMessage(Nullable<UInt32>)
Creates a message instance.
Declaration
public SubscribeToGroupMessage(uint? groupID)Parameters
| Type | Name | Description |
|---|---|---|
| Nullable<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 SourceEventName
Message event name.
Declaration
[JsonIgnore]
public string EventName { get; }Property Value
| Type | Description |
|---|---|
| String |
Remarks
Equals to MessageGroupSubscribe.
GroupID
ID of the group.
Declaration
[JsonProperty("id", NullValueHandling = NullValueHandling.Ignore, DefaultValueHandling = DefaultValueHandling.Ignore)]
public uint? GroupID { get; }Property Value
| Type | Description |
|---|---|
| Nullable<UInt32> |
Remarks
When this value is null, request will subscribe to messages from all groups.
Headers
Message payload headers.
Declaration
[JsonIgnore]
public IDictionary<string, object> Headers { get; }Property Value
| Type | Description |
|---|---|
| IDictionary<String, Object> |