Class SubscribeObject

Class for the subscription request object. See Section 2.1.5.1 of NENA-STA-024.1a-2023.

Inheritance

System.Object

SubscribeObject

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 SubscribeObject

Properties

expires

Number of seconds after which the subscription shall expire. Optional.

Declaration

public int? expires { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

incidentId

The Incident Tracking Identifier associated with the call. CONDITIONAL. For ONLY request type “EIDO” and subtype “single”, MUST be present to subscribe to a specific incident. MUST not be present for other subtypes.

Declaration

public string incidentId { get; set; }

Property Value

Type	Description
System.String

maxRate

Minimum time in seconds to wait between notifications which is the maximum rate at which notifications are sent consistent with RFC 6446. If not specified there is no maximum rate. OPTIONAL if and only if a subscriptionId is not specified, otherwise MUST NOT be specified.

Declaration

public int? maxRate { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

minRate

Number of seconds after the last notification after which a notification must be sent consistent with RFC 6446. If not specified there is no minimum rate. OPTIONAL if and only if a subscriptionId is not specified, otherwise MUST NOT be specified.

Declaration

public int? minRate { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

qualFilter

When subscribing for new incidents, the qualFilter may be used to be notified of a subset thereof. A qualFilter MUST NOT be specified if an incidentId is specified. OPTIONAL if requestType is “EIDO” and incidentId is not specified.

Declaration

public string qualFilter { get; set; }

Property Value

Type	Description
System.String

qualFilterEvalPeriod

If qualFilter specified, a positive integer specifying the requested number of seconds between qualFilter evaluations. OPTIONAL if qualFilter specified, otherwise MUST NOT be specified.

Declaration

public int? qualFilterEvalPeriod { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

requestAccepts

The MIME type associated with the requestType and the major versions thereof accepted in the notification payload as a quoted comma-delimited list, as in the Accept HTTP header per RFC 7231 [13], e.g., application/emergency.eido+json; version=”1” or application/emergency.eido+json; version=”1,2,3”. The version is required and is the only extension parameter permitted. REQUIRED for a new subscription, i.e., if subscriptionId is not specified.

Declaration

public string requestAccepts { get; set; }

Property Value

Type	Description
System.String

requestId

An ID generated by the subscriber that will be returned by the notifier in its response to the request. Required.

Declaration

public string requestId { get; set; }

Property Value

Type	Description
System.String

requestSubType

The requestSubType provides for different actions based on the requestType specified. If requestType is omitted, then requestSubType MUST be omitted. If requestType is “EIDO”, requestSubType MUST be present and MUST be one of “single” or “new”. Other request types may have their own conditions or may not require a subtype.

Declaration

public string requestSubType { get; set; }

Property Value

Type	Description
System.String

requestType

Type of request, e.g., “EIDO”. REQUIRED for a new subscription (i.e., if no subscriptionId provided), otherwise, MUST be omitted.

Declaration

public string requestType { get; set; }

Property Value

Type	Description
System.String

subscriptionId

The subscriptionId previously returned by the notifier in the subscribeResponse. This is used for keeping a subscription alive. Optional.

Declaration

public string subscriptionId { get; set; }

Property Value

Type	Description
System.String