Skip to content

craft-hub / IntegrationProvider

Interface: IntegrationProvider ​

Defined in: packages/craft-hub/src/integrations.ts:283

Trusted host implementation used by declarative marketplace integrations.

Properties ​

apiVersion ​

apiVersion: string

Defined in: packages/craft-hub/src/integrations.ts:286


ci? ​

optional ci?: CiIntegrationAdapter

Defined in: packages/craft-hub/src/integrations.ts:304


configuration? ​

optional configuration?: object

Defined in: packages/craft-hub/src/integrations.ts:297

list ​

list: (context, input?) => Promise<IntegrationEntityPage>

Parameters ​
context ​

IntegrationProviderContext

input? ​

Record<string, unknown>

Returns ​

Promise<IntegrationEntityPage>

update? ​

optional update?: (context, input) => Promise<IntegrationEntityPage>

Parameters ​
context ​

IntegrationProviderContext

input ​

Record<string, unknown>

Returns ​

Promise<IntegrationEntityPage>


configurationManagement? ​

optional configurationManagement?: object

Defined in: packages/craft-hub/src/integrations.ts:299

Workstation-backed review, apply and recovery; results contain display-safe values only.

execute ​

execute: (context, input) => Promise<ConfigurationManagementPage>

Parameters ​
context ​

IntegrationProviderContext

input ​

Record<string, unknown>

Returns ​

Promise<ConfigurationManagementPage>

read ​

read: (context, input) => Promise<ConfigurationManagementPage>

Parameters ​
context ​

IntegrationProviderContext

input ​

Record<string, unknown>

Returns ​

Promise<ConfigurationManagementPage>

update ​

update: (context, input) => Promise<ConfigurationManagementPage>

Parameters ​
context ​

IntegrationProviderContext

input ​

Record<string, unknown>

Returns ​

Promise<ConfigurationManagementPage>


connection? ​

optional connection?: object

Defined in: packages/craft-hub/src/integrations.ts:288

complete? ​

optional complete?: (context, input) => Promise<IntegrationConnectionStatus>

Parameters ​
context ​

IntegrationProviderContext

input ​

Record<string, unknown>

Returns ​

Promise<IntegrationConnectionStatus>

update ​

update: (context, input) => Promise<IntegrationConnectionStatus>

Parameters ​
context ​

IntegrationProviderContext

input ​

Record<string, unknown>

Returns ​

Promise<IntegrationConnectionStatus>


connectionStatus ​

connectionStatus: (context) => Promise<IntegrationConnectionStatus>

Defined in: packages/craft-hub/src/integrations.ts:287

Parameters ​

context ​

IntegrationProviderContext

Returns ​

Promise<IntegrationConnectionStatus>


id ​

id: string

Defined in: packages/craft-hub/src/integrations.ts:285


issues? ​

optional issues?: IssueIntegrationAdapter

Defined in: packages/craft-hub/src/integrations.ts:296


mergeRequests? ​

optional mergeRequests?: MergeRequestIntegrationAdapter

Defined in: packages/craft-hub/src/integrations.ts:295


repositories? ​

optional repositories?: RepositoryIntegrationAdapter

Defined in: packages/craft-hub/src/integrations.ts:294


resources? ​

optional resources?: ResourcePageAdapter

Defined in: packages/craft-hub/src/integrations.ts:284


workItems? ​

optional workItems?: WorkItemIntegrationAdapter

Defined in: packages/craft-hub/src/integrations.ts:292


workspaces? ​

optional workspaces?: WorkspaceIntegrationAdapter

Defined in: packages/craft-hub/src/integrations.ts:293

Released under the MIT License.