Class SubscribeResponseObject

Class for the body of the subscribe response.

Inheritance
System.Object
SubscribeResponseObject
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: WebSocketSubNot
Assembly: EidoLib.dll
Syntax
public class SubscribeResponseObject

Properties

expires

Subscription period in seconds relative to the notifier’s establishment or renewal of the subscription. REQUIRED if subscription is accepted.

Declaration
public int? expires { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

maxRate

May be a shorter period than requested but not longer. REQUIRED if specified by the subscriber.

Declaration
public int? maxRate { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

minRate

May be a longer period than requested but not shorter. REQUIRED if specified by the subscriber.

Declaration
public int? minRate { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

qualFilterEvalPeriod

Negotiated number of seconds between qualFilter evaluations. If requested, may be a longer period than the request but not shorter. REQUIRED if qualFilter specified.

Declaration
public int? qualFilterEvalPeriod { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

requestId

The ID provided by the subscriber. Required.

Declaration
public string requestId { get; set; }
Property Value
Type Description
System.String

statusCode

The statusCode element is a 3-digit integer result code of the attempt to understand and satisfy the request as defined in the SubscribeResponseEnum enumeration. Required.

Declaration
public int statusCode { get; set; }
Property Value
Type Description
System.Int32

statusText

The statusText provides a short textual description related to the statusCode. Required.

Declaration
public string statusText { get; set; }
Property Value
Type Description
System.String

subscriptionId

The globally unique identifier for the subscription. REQUIRED if subscription is accepted.

Declaration
public string subscriptionId { get; set; }
Property Value
Type Description
System.String