dc-management-sdk-js
    Preparing search index...

    Class Extension

    Class representing the Extension resource.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _links? category createdBy createdDate description? height? hubId? id? label lastModifiedBy lastModifiedDate name parameters? related settings? snippets? status url

    Methods

    performActionWithoutResourceResponse toJson toJSON

    Constructors

    Properties

    Optional_links

    _links?: Map<string, HalLink>
    category: "CONTENT_FIELD" | "DASHBOARD"

    Category of the extension

    createdBy: string

    User who created the Extension

    createdDate: string

    Created date of the extension

    description?: string

    Description for the extension

    height?: number

    Height of the extension

    hubId?: string

    Id of the associated hub

    id?: string

    Id of the extension

    label: string

    User friendly name of the extension

    lastModifiedBy: string

    User who last changed the Extension

    lastModifiedDate: string

    Last modified date of the extension

    name: string

    System name of the extension

    parameters?: string

    JSON config parameters of the extension

    related: {
        delete: () => Promise<void>;
        hub: () => Promise<Hub>;
        update: (mutation: Extension) => Promise<Extension>;
    } = ...

    Resources and actions related to an Extension

    Type declaration

    • delete: () => Promise<void>

      Deletes this extension.

    • hub: () => Promise<Hub>

      Retrieves the Hub this extension is stored in

    • update: (mutation: Extension) => Promise<Extension>

      Updates this extension with the changes in the mutation parameter.

    settings?: string

    Settings of the extension, as a JSON string

    snippets?: ExtensionSnippet[]

    Array of snippets

    status: Status

    Status of the extension

    url: string

    Base url for the extension

    Methods

    • POST to an action endpoint with no resource response returned.

      Parameters

      • name: string
      • params: any
      • data: any
      • method: POST | PUT | PATCH = HttpMethod.POST

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods