SourceLifecycle

16 min

OCP App SDK

OCP App SDK / SourceLifecycle

Class: abstract SourceLifecycle

Defined in: src/app/SourceLifecycle.ts:14

Constructors

Constructor

new SourceLifecycle(config): SourceLifecycle

Defined in: src/app/SourceLifecycle.ts:17

Parameters

config

SourceConfiguration

Returns

SourceLifecycle

Properties

config

protected config: SourceConfiguration

Defined in: src/app/SourceLifecycle.ts:15

Methods

onSourceCreate()

abstract onSourceCreate(): Promise<SourceCallbackResponse>

Defined in: src/app/SourceLifecycle.ts:26

Called when a sources is created. Use this method to setup the source webhooks so it is in a state to recieve data.

Returns

Promise<SourceCallbackResponse>

onSourceDelete()

abstract onSourceDelete(): Promise<SourceCallbackResponse>

Defined in: src/app/SourceLifecycle.ts:39

Called when a sources is deleted. Use this method to perform any cleanup tasks.

Returns

Promise<SourceCallbackResponse>

onSourceEnable()

abstract onSourceEnable(): Promise<SourceCallbackResponse>

Defined in: src/app/SourceLifecycle.ts:44

Called when a sources is enabled.

Returns

Promise<SourceCallbackResponse>

onSourcePause()

abstract onSourcePause(): Promise<SourceCallbackResponse>

Defined in: src/app/SourceLifecycle.ts:49

Called when a sources is paused.

Returns

Promise<SourceCallbackResponse>

onSourceUpdate()

abstract onSourceUpdate(): Promise<SourceCallbackResponse>

Defined in: src/app/SourceLifecycle.ts:33

Called when a sources is updated. Use this method to update the source webhooks so it is in a state to recieve data.

Returns

Promise<SourceCallbackResponse>