Class GroupProfileMessage

A message for requesting group profile.

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

Uses GroupProfileResponse as response type.

Constructors

| Improve this Doc View Source

GroupProfileMessage()

Creates a message instance.

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

GroupProfileMessage(IEnumerable<UInt32>, Boolean)

Creates a message instance.

Declaration
public GroupProfileMessage(IEnumerable<uint> groupIDs, bool subscribe = true)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.UInt32> groupIDs

IDs of the groups to request.
System.Boolean subscribe

Subscribe to groups' profile updates?
| Improve this Doc View Source

GroupProfileMessage(IEnumerable<UInt32>, IEnumerable<String>, Boolean)

Creates a message instance.

Declaration
public GroupProfileMessage(IEnumerable<uint> groupIDs, IEnumerable<string> requestEntities, bool subscribe = true)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.UInt32> groupIDs

IDs of the groups to request.
System.Collections.Generic.IEnumerable<System.String> requestEntities

Names of entities to request.
System.Boolean subscribe

Subscribe to groups' profile updates?
| Improve this Doc View Source

GroupProfileMessage(String, Boolean)

Creates a message instance.

Declaration
public GroupProfileMessage(string groupName, bool subscribe = true)
Parameters
Type Name Description
System.String groupName

Name of the group to request.
System.Boolean subscribe

Subscribe to groups' profile updates?
| Improve this Doc View Source

GroupProfileMessage(String, IEnumerable<String>, Boolean)

Creates a message instance.

Declaration
public GroupProfileMessage(string groupName, IEnumerable<string> requestEntities, bool subscribe = true)
Parameters
Type Name Description
System.String groupName

Name of the group to request.
System.Collections.Generic.IEnumerable<System.String> requestEntities

Names of entities to request.
System.Boolean subscribe

Subscribe to groups' profile updates?

Fields

| Improve this Doc View Source

DefaultRequestEntities

Default group entities to request.

Declaration
[JsonIgnore]
public static readonly IEnumerable<string> DefaultRequestEntities
Field Value
Type Description
System.Collections.Generic.IEnumerable<System.String>

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

| 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

RequestEntities

Requested entities.

Declaration
[JsonProperty("entities")]
public IEnumerable<string> RequestEntities { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.String>
| Improve this Doc View Source

RequestGroupIDs

IDs of requested groups. Mutually exclusive with RequestGroupName

Declaration
[JsonProperty("idList", NullValueHandling = NullValueHandling.Ignore)]
public IEnumerable<uint> RequestGroupIDs { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.UInt32>
| Improve this Doc View Source

RequestGroupName

Name of the requested group. Mutually exclusive with RequestGroupIDs.

Declaration
[JsonProperty("name", NullValueHandling = NullValueHandling.Ignore)]
public string RequestGroupName { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

SubscribeToUpdates

Subscribe to groups' profile updates?

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

Implements

IHeadersWolfMessage
IWolfMessage

Extension Methods

SerializationHelper.SerializeJsonPayload<T>(T, JsonSerializer)