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

    Class Hub

    Class representing the Hub resource. Hubs are containers for multiple repositories including media, content, content types.

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _links?: Map<string, HalLink>
    createdBy?: string

    Id of the user responsible for originally creating the Hub

    createdDate?: string

    Timestamp representing when the Hub was originally created in ISO 8601 format

    description?: string

    Textual description of the Hub

    id?: string

    Unique id generated on creation

    label?: string

    Friendly display label for the Hub

    lastModifiedBy?: string

    Id of the user responsible for the last update to the Hub

    lastModifiedDate?: string

    Timestamp representing when the Hub was last updated in ISO 8601 format

    name?: string

    Globally unique programmatic name for the Hub

    related: {
        contentItems: {
            facet: (
                facetQuery: FacetQuery,
                options?: Pageable & Sortable & { query: string },
            ) => Promise<FacetsResponse<FacetedContentItem>>;
        };
        contentRepositories: {
            findByFeature: (
                feature: string,
                options?: Pageable & Sortable,
            ) => Promise<Page<ContentRepository>>;
            list: (options?: Pageable & Sortable) => Promise<Page<ContentRepository>>;
        };
        contentTypes: {
            get: (id: string) => Promise<ContentType>;
            list: (
                options?: Pageable & Sortable & StatusFilterable,
            ) => Promise<Page<ContentType>>;
            register: (resource: ContentType) => Promise<ContentType>;
        };
        contentTypeSchema: {
            create: (resource: ContentTypeSchema) => Promise<ContentTypeSchema>;
            list: (options?: Pageable) => Promise<Page<ContentTypeSchema>>;
        };
        editions: {
            findByDate: (
                options?: FindByDate & Pageable & Sortable,
                projection?: string,
            ) => Promise<Page<Edition>>;
        };
        events: {
            create: (resource: Event) => Promise<Event>;
            list: (options?: Pageable & Sortable) => Promise<Page<Event>>;
        };
        extensions: {
            create: (resource: Extension) => Promise<Extension>;
            getByName: (name: string) => Promise<Extension>;
            list: (options?: Pageable & Sortable) => Promise<Page<Extension>>;
        };
        searchIndexes: {
            create: (resource: SearchIndex) => Promise<SearchIndex>;
            get: (id: string) => Promise<SearchIndex>;
            list: (
                parentId?: string,
                projection?: string,
                options?: Pageable & Sortable,
            ) => Promise<Page<SearchIndex>>;
        };
        settings: { update: (mutation: Settings) => Promise<Settings> };
        snapshots: { create: (request: Snapshot[]) => Promise<SnapshotResultList> };
        webhooks: {
            create: (resource: Webhook) => Promise<Webhook>;
            get: (id: string) => Promise<Webhook>;
            list: (options?: Pageable & Sortable) => Promise<Page<Webhook>>;
        };
        workflowStates: {
            create: (resource: WorkflowState) => Promise<WorkflowState>;
            get: (id: string) => Promise<WorkflowState>;
            list: (options?: Pageable & Sortable) => Promise<Page<WorkflowState>>;
        };
    } = ...

    Resources and actions related to a Hub

    settings?: Settings

    Hub settings

    status?: Status

    Lifecycle status of the Hub

    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>