struct PlaceOS::Api::MicrosoftNotification::ChangeNotification

Included Modules

Extended Modules

Defined in:

placeos-rest-api/controllers/notifications/microsoft.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def client_state : String | Nil #

Value of the clientState property sent in the subscription request (if any). The maximum length is 255 characters. The client can check whether the change notification came from the service by comparing the values of the clientState property. The value of the clientState property sent with the subscription is compared with the value of the clientState property received with each change notification. Optional.


[View source]
def encrypted_content : EncryptedContent | Nil #

The Encrypted Content. (Preview) Encrypted content attached with the change notification. Only provided if encryptionCertificate and includeResourceData were defined during the subscription request and if the resource supports it. Optional.


[View source]
def event : LifecycleEvent | Nil #

The Lifecycle Event. The type of lifecycle notification if the current notification is a lifecycle notification. Optional. Supported values are missed, subscriptionRemoved, reauthorizationRequired. Optional.


[View source]
def id : String | Nil #

Unique ID for the notification. Optional.


[View source]
def resource : String | Nil #

The URI of the resource that emitted the change notification relative to https://graph.microsoft.com. Required.


[View source]
def resource_data : ResourceData | Nil #

The content of this property depends on the type of resource being subscribed to. Optional.


[View source]
def subscription_expiry : Time #

The expiration time for the subscription. Required.


[View source]
def subscription_id : String #

The unique identifier of the subscription that generated the notification.Required.


[View source]
def tenant_id : String #

The unique identifier of the tenant from which the change notification originated. Required.


[View source]
def to_payload #

[View source]
def type : ChangeType | Nil #

Indicates the type of change that will raise the change notification. The supported values are: created, updated, deleted. Required.


[View source]