Class SubscriptionResponse

Complete details for an event subscription.

Constructors

constructor

Properties

active createdAt eventType id objectTypeId? propertyName? updatedAt? attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

active

active: boolean

Determines if the subscription is active or paused.

createdAt

createdAt: Date

When this subscription was created. Formatted as milliseconds from the Unix epoch.

eventType

eventType: SubscriptionResponseEventTypeEnum

Type of event to listen for. Can be one of create, delete, deletedForPrivacy, or propertyChange.

id

id: string

The unique ID of the subscription.

OptionalobjectTypeId

objectTypeId?: string

The identifier of the object type associated with the subscription.

OptionalpropertyName

propertyName?: string

The internal name of the property being monitored for changes. Only applies when eventType is propertyChange.

OptionalupdatedAt

updatedAt?: Date

When this subscription was last updated. Formatted as milliseconds from the Unix epoch.

Static ReadonlyattributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Static Readonlydiscriminator

discriminator: undefined | string = undefined

Static Readonlymapping

mapping: undefined | {
    [index: string]: string;
} = undefined

Methods

StaticgetAttributeTypeMap

  • getAttributeTypeMap(): {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods