Docs for m2-core, m2-components
  1. Classes
  2. SubscribeRequest

File

projects/m2-core/src/lib/core/service/callback/requests/SubscribeRequest.ts

Index

Properties

Constructor

constructor(subscriptionType: SubscriptionType, tabId: string, subscribeLocation?: string, subscribeElements?: number[], startUnsubscribeLocation?: string, unSubscribeElements?: number[])
Parameters :
Name Type Optional
subscriptionType SubscriptionType No
tabId string No
subscribeLocation string Yes
subscribeElements number[] Yes
startUnsubscribeLocation string Yes
unSubscribeElements number[] Yes

Properties

Public Optional startUnsubscribeLocation
Type : string

Начало пути UI для отписываемых объектов. Отписка выполняется только в том случае, если он не пуст. Если список unSubscribeElementDescriptors не пуст, то startUnsubscribeLocation должен быть задан обязательно. Если список unSubscribeElementDescriptors пуст, а startUnsubscribeLocation задан, то выполняется отписка от всех элементов для данного tabId и subscriptionType у которых путь начинается с startUnsubscribeLocation
Public subscribeElements
Type : number[]

Идентификаторы подписываемых объектов, может быть пусто, если подписка не требуется
Public Optional subscribeLocation
Type : string

Путь UI для подписываемых объектов. Обязательно должно быть задано, subscribeElementDescriptors непусто
Public subscriptionType
Type : SubscriptionType

Тип подписки
Public tabId
Type : string

Идентификатор вкладки выданный (возможно в будущем) при установке соединения web-socket
Public unSubscribeElements
Type : number[]

Идентификаторы отписываемых объектов, может быть пусто, если отписка не требуется или нужно отписаться от всего по началу пути startUnsubscribeLocation

results matching ""

    No results matching ""