Hub | dc-management-sdk-js

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

Hierarchy

HalResource
- Hub

Index

Constructors

constructor

Properties

Methods

Object literals

Constructors

constructor

new Hub(data?: any): Hub

Inherited from HalResource.constructor
- Defined in src/lib/hal/models/HalResource.ts:28
Creates a new instance of the resource. If data is provided it will be parsed as if it had come from the remote api.

Parameters
- Optional data: any
Returns Hub

Properties

Optional _links

_links: Map<string, HalLink>

Optional createdBy

createdBy: string

Id of the user responsible for originally creating the Hub

Optional createdDate

createdDate: string

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

Optional description

description: string

Textual description of the Hub

Optional id

id: string

Unique id generated on creation

Optional label

label: string

Friendly display label for the Hub

Optional lastModifiedBy

lastModifiedBy: string

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

Optional lastModifiedDate

lastModifiedDate: string

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

Optional name

name: string

Globally unique programmatic name for the Hub

Optional settings

settings: Settings

Hub settings

Optional status

status: Status

Lifecycle status of the Hub

Methods

Protected performActionWithoutResourceResponse

performActionWithoutResourceResponse(name: string, params: any, data: any, method?: POST | PATCH | PUT): Promise<void>

Inherited from HalResource.performActionWithoutResourceResponse
- Defined in src/lib/hal/models/HalResource.ts:155
POST to an action endpoint with no resource response returned.

Parameters
- name: string
- params: any
- data: any
- Default value method: POST | PATCH | PUT = HttpMethod.POST
Returns Promise<void>

toJSON

toJSON(): any

Inherited from HalResource.toJSON
- Defined in src/lib/hal/models/HalResource.ts:53
Returns a copy of this resource's attributes excluding links and client references

Returns any

toJson

toJson(): any

Inherited from HalResource.toJson
- Defined in src/lib/hal/models/HalResource.ts:65
Returns a copy of this resource's attributes excluding links and client references

deprecated

Returns any

Object literals

Readonly related

related: object

Resources and actions related to a Hub

contentItems

contentItems: object

facet

facet(facetQuery: FacetQuery, options?: Pageable & Sortable & { query: string }): Promise<FacetsResponse<FacetedContentItem>>

- Defined in src/lib/model/Hub.ts:171
Facet content items and search by text. See Text Search Query Syntax for a summary of the query syntax.

Parameters
- facetQuery: FacetQuery
- Optional options: Pageable & Sortable & { query: string }
Returns Promise<FacetsResponse<FacetedContentItem>>

contentRepositories

contentRepositories: object

findByFeature

findByFeature(feature: string, options?: Pageable & Sortable): Promise<Page<ContentRepository>>

- Defined in src/lib/model/Hub.ts:126
Find all the Content Repositories that contain a feature

Parameters
- feature: string
- Optional options: Pageable & Sortable
  
  Options
Returns Promise<Page<ContentRepository>>

list

list(options?: Pageable & Sortable): Promise<Page<ContentRepository>>

- Defined in src/lib/model/Hub.ts:115
Retrieves a list of Content Repositories associated with this Hub

Parameters
- Optional options: Pageable & Sortable
  
  Pagination options
Returns Promise<Page<ContentRepository>>

contentTypeSchema

contentTypeSchema: object

create

create(resource: ContentTypeSchema): Promise<ContentTypeSchema>

- Defined in src/lib/model/Hub.ts:90
Creates a new Content Type Schema

Parameters
- resource: ContentTypeSchema
Returns Promise<ContentTypeSchema>

list

list(options?: Pageable): Promise<Page<ContentTypeSchema>>

- Defined in src/lib/model/Hub.ts:102
Retrieves a list of Content Type Schemas associated with this Hub

Parameters
- Optional options: Pageable
  
  Pagination options
Returns Promise<Page<ContentTypeSchema>>

contentTypes

contentTypes: object

get

get(id: string): Promise<ContentType>

- Defined in src/lib/model/Hub.ts:163
Get a content type by its id

Parameters
- id: string
Returns Promise<ContentType>

list

list(options?: Pageable & Sortable & StatusFilterable): Promise<Page<ContentType>>

- Defined in src/lib/model/Hub.ts:144
Retrieves a list of Content Types associated with this Hub

Parameters
- Optional options: Pageable & Sortable & StatusFilterable
  
  Pagination options
Returns Promise<Page<ContentType>>

register

- Defined in src/lib/model/Hub.ts:152
Register a Content Type on a hub so it can be enabled on a repository

Parameters
- resource: ContentType
Returns Promise<ContentType>

editions

editions: object

findByDate

findByDate(options?: FindByDate & Pageable & Sortable, projection?: string): Promise<Page<Edition>>

- Defined in src/lib/model/Hub.ts:188
Find editions by date associated with this Hub

Parameters
- Optional options: FindByDate & Pageable & Sortable
  
  FindByDate & Pageable & Sortable options
- Optional projection: string
Returns Promise<Page<Edition>>

events

events: object

create

create(resource: Event): Promise<Event>

- Defined in src/lib/model/Hub.ts:204
Creates an Event inside this Hub

Parameters
- resource: Event
Returns Promise<Event>

list

list(options?: Pageable & Sortable): Promise<Page<Event>>

- Defined in src/lib/model/Hub.ts:211
Retrieves a list of Events associated with this Hub

Parameters
- Optional options: Pageable & Sortable
  
  Pagination options
Returns Promise<Page<Event>>

extensions

extensions: object

create

create(resource: Extension): Promise<Extension>

- Defined in src/lib/model/Hub.ts:220
Creates an Extension inside this Hub

Parameters
- resource: Extension
Returns Promise<Extension>

getByName

getByName(name: string): Promise<Extension>

- Defined in src/lib/model/Hub.ts:226
Get an Extension inside this Hub by its name

Parameters
- name: string
Returns Promise<Extension>

list

list(options?: Pageable & Sortable): Promise<Page<Extension>>

- Defined in src/lib/model/Hub.ts:233
Retrieves a list of Extension associated with this Hub

Parameters
- Optional options: Pageable & Sortable
  
  Pagination options
Returns Promise<Page<Extension>>

searchIndexes

searchIndexes: object

create

create(resource: SearchIndex): Promise<SearchIndex>

- Defined in src/lib/model/Hub.ts:242
Create a search index for a given hub

Parameters
- resource: SearchIndex
Returns Promise<SearchIndex>

get

get(id: string): Promise<SearchIndex>

- Defined in src/lib/model/Hub.ts:259
Get a search index by its id

Parameters
- id: string
Returns Promise<SearchIndex>

list

list(parentId?: string, projection?: string, options?: Pageable & Sortable): Promise<Page<SearchIndex>>

- Defined in src/lib/model/Hub.ts:268
Retrieves a list of search indexes associated with this Hub

Parameters
- Optional parentId: string
- Optional projection: string
- Optional options: Pageable & Sortable
Returns Promise<Page<SearchIndex>>

settings

settings: object

update

update(mutation: Settings): Promise<Settings>

- Defined in src/lib/model/Hub.ts:284
Updates this hub settings with the changes in the mutation parameter.

Parameters
- mutation: Settings
Returns Promise<Settings>

snapshots

snapshots: object

create

create(request: Snapshot[]): Promise<SnapshotResultList>

- Defined in src/lib/model/Hub.ts:300
Creates a Snapshot inside this Hub

Parameters
- request: Snapshot[]
Returns Promise<SnapshotResultList>

webhooks

webhooks: object

create

create(resource: Webhook): Promise<Webhook>

- Defined in src/lib/model/Hub.ts:314
Creates a Webhook inside this Hub

Parameters
- resource: Webhook
Returns Promise<Webhook>

get

get(id: string): Promise<Webhook>

- Defined in src/lib/model/Hub.ts:320
Get a Webhook inside this Hub by its id

Parameters
- id: string
Returns Promise<Webhook>

list

list(options?: Pageable & Sortable): Promise<Page<Webhook>>

- Defined in src/lib/model/Hub.ts:327
Retrieves a list of Webhooks associated with this Hub

Parameters
- Optional options: Pageable & Sortable
  
  Pagination options
Returns Promise<Page<Webhook>>

workflowStates

workflowStates: object

create

create(resource: WorkflowState): Promise<WorkflowState>

- Defined in src/lib/model/Hub.ts:336
Creates a Workflow State inside this Hub

Parameters
- resource: WorkflowState
Returns Promise<WorkflowState>

get

get(id: string): Promise<WorkflowState>

- Defined in src/lib/model/Hub.ts:348
Get a Webhook State insidee this Hub by its id

Parameters
- id: string
Returns Promise<WorkflowState>

list

list(options?: Pageable & Sortable): Promise<Page<WorkflowState>>

- Defined in src/lib/model/Hub.ts:355
Retrieves a list of Workflow States associated with this Hub

Parameters
- Optional options: Pageable & Sortable
  
  Pagination options
Returns Promise<Page<WorkflowState>>

Hierarchy

Index

Constructors

Properties

Methods

Object literals

Constructors

constructor

Parameters

Optional data: any

Returns Hub

Properties

Optional _links

Optional createdBy

Optional createdDate

Optional description

Optional id

Optional label

Optional lastModifiedBy

Optional lastModifiedDate

Optional name

Optional settings

Optional status

Methods

Protected performActionWithoutResourceResponse

Parameters

name: string

params: any

data: any

Default value method: POST | PATCH | PUT = HttpMethod.POST

Returns Promise<void>

toJSON

Returns any

toJson

Returns any

Object literals

Readonly related

contentItems

facet

Parameters

facetQuery: FacetQuery

Optional options: Pageable & Sortable & { query: string }

Returns Promise<FacetsResponse<FacetedContentItem>>

contentRepositories

findByFeature

Parameters

feature: string

Optional options: Pageable & Sortable

Returns Promise<Page<ContentRepository>>

list

Parameters

Optional options: Pageable & Sortable

Returns Promise<Page<ContentRepository>>

contentTypeSchema

create

Parameters

resource: ContentTypeSchema

Returns Promise<ContentTypeSchema>

list

Parameters

Optional options: Pageable

Returns Promise<Page<ContentTypeSchema>>

contentTypes

get

Parameters

id: string

Returns Promise<ContentType>

list

Parameters

Optional options: Pageable & Sortable & StatusFilterable

Returns Promise<Page<ContentType>>

register

Parameters

resource: ContentType

Returns Promise<ContentType>

editions

findByDate

Parameters

Optional options: FindByDate & Pageable & Sortable

Optional projection: string