ctrlX Data Layer API for Python  3.4.0
The ctrlX Data Layer API allows access to the ctrlX Data Layer with Python
All Classes Functions Pages
ProviderSubscription Class Reference

Public Member Functions

def __init__ (self, C_DLR_SUBSCRIPTION sub)
 
str get_id (self)
 
typing.List[str] get_notes (self)
 
comm.datalayer.SubscriptionProperties get_props (self)
 
datetime.datetime get_timestamp (self)
 
int get_unique_id (self)
 
Result publish (self, Result status, typing.List[NotifyItemPublish] items)
 

Detailed Description

ProviderSubscription helper class.

Definition at line 297 of file provider_subscription.py.

Member Function Documentation

◆ get_id()

str get_id (   self)

◆ get_notes()

typing.List[str] get_notes (   self)

get_notes

Returns
typing Subscribed nodes as array of strings

Definition at line 349 of file provider_subscription.py.

References ProviderSubscription.__subscription.

◆ get_props()

comm.datalayer.SubscriptionProperties get_props (   self)

get_props

Returns
comm subscription properties

Definition at line 331 of file provider_subscription.py.

References ProviderSubscription.__subscription.

Referenced by ProviderSubscription.get_id().

◆ get_timestamp()

datetime.datetime get_timestamp (   self)

timestamp

Returns
datetime timestamp

Definition at line 340 of file provider_subscription.py.

References ProviderSubscription.__subscription.

◆ get_unique_id()

int get_unique_id (   self)

get_unique_id

Returns
int unique subscription identifier

Definition at line 312 of file provider_subscription.py.

References ProviderSubscription.__subscription.

◆ publish()

Result publish (   self,
Result  status,
typing.List[NotifyItemPublish items 
)

publish

Parameters
statusStatus of notification. On failure subscription is canceled for all items.
itemsNotification items

Definition at line 360 of file provider_subscription.py.

References ProviderSubscription.__subscription.