Class WorkflowSubscriptionService

Hierarchy

Index

Constructor methods

Methods

Constructor methods

constructor(context: ClientRuntimeContext, objectPath: ObjectPathStaticProperty): WorkflowSubscriptionService

Parameters

Returns

WorkflowSubscriptionService

Methods

public customFromJson(initValue: any): boolean

Parameters

  • initValue: any

Returns

boolean

public deleteSubscription(subscriptionId: any): WorkflowSubscription

Parameters

  • subscriptionId: any

Returns

WorkflowSubscription

public enumerateSubscriptions(): WorkflowSubscriptionCollection

Retrieves workflow subscriptions that contains all of the workflow subscriptions on the Web

Returns

WorkflowSubscriptionCollection

public enumerateSubscriptionsByDefinition(definitionId: string): WorkflowSubscriptionCollection

Retrieves workflow subscriptions based on workflow definition

Parameters

  • definitionId: string

Returns

WorkflowSubscriptionCollection

public enumerateSubscriptionsByEventSource(eventSourceId: string): WorkflowSubscriptionCollection

Retrieves workflow subscriptions based on the specified EventSourceId

Parameters

  • eventSourceId: string

Returns

WorkflowSubscriptionCollection

public enumerateSubscriptionsByList(listId: string): WorkflowSubscriptionCollection

Retrieves workflow subscriptions based on the specified list.

Parameters

  • listId: string

    The unique identifier (GUID) of the list on which to filter the subscriptions.

Returns

WorkflowSubscriptionCollection

public fromJson(initValue: any)

Parameters

  • initValue: any

public static getCurrent(context: ClientRuntimeContext): WorkflowSubscriptionService

Parameters

Returns

WorkflowSubscriptionService

public getSubscription(subscriptionId: any): WorkflowSubscription

Parameters

  • subscriptionId: any

Returns

WorkflowSubscription

public get_context(): ClientRuntimeContext

Returns

ClientRuntimeContext

public get_objectVersion(): string

Returns

string

public get_path(): ObjectPath

Returns

ObjectPath

public get_serverObjectIsNull(): boolean

Returns

boolean

public get_typedObject(): ClientObject

Returns

ClientObject

public isObjectPropertyInstantiated(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public isPropertyAvailable(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public publishSubscription(subscription: WorkflowSubscription): GuidResult

Creates a workflow subscription for a workflow, and returns the unique identifier of the new subscription.

Parameters

Returns

GuidResult

public publishSubscriptionForList(subscription: WorkflowSubscription, listId: string): GuidResult

Creates a workflow subscription for a workflow and if necessary an event receiver on the specified list. Also writes an EventSourceId that matches the list as the event source. Returns the unique identifier of the new subscription.

Parameters

  • subscription: WorkflowSubscription
  • listId: string

    Unique identifier (GUID) for the specified list.

Returns

GuidResult

public refreshLoad()

public registerInterestInList(listId: string, eventName: string)

Ensures that an event receiver will monitor a list for the specified event.

eventname

eventName The name of the event to be monitored.

Parameters

  • listId: string

    Unique identifier (GUID) for the specified list.

  • eventName: string

public retrieve()

public retrieve(propertyNames: Array<string>)

Parameters

  • propertyNames: Array<string>

public set_objectVersion(value: string)

Parameters

  • value: string

public unregisterInterestInList(listId: string, eventName: string)

Removes monitoring for an event receiver on the specified list with the specified event.

eventname

eventName The name of the event to be removed.

Parameters

  • listId: string

    GUID of the list containing the event receiver to be unregistered.

  • eventName: string