Class ContentType

Class representing the Content Type resource. Content types are JSON schemas that define a type of content to be created, including its structure, format and validation rules.

Hierarchy (View Summary)

HalResource
- ContentType

Index

Constructors

constructor

new ContentType(data?: any): ContentType
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
- Optionaldata: any
Returns ContentType
Inherited from HalResource.constructor
- Defined in src/lib/hal/models/HalResource.ts:35

Properties

`Optional`_links

_links?: Map<string, HalLink>

`Optional`contentTypeUri

contentTypeUri?: string

URI that describes where to locate the JSON schema definition for this content type

`Optional`id

id?: string

Unique id generated on creation

`Readonly`related

related: {
    archive: () => Promise<ContentType>;
    contentTypeSchema: {
        get: () => Promise<ContentTypeCachedSchema>;
        update: (
            mutation?: ContentTypeCachedSchema,
        ) => Promise<ContentTypeCachedSchema>;
    };
    unarchive: () => Promise<ContentType>;
    update: (mutation: ContentType) => Promise<ContentType>;
} = ...

Resources and actions related to a ContentType

Type declaration

archive: () => Promise<ContentType>
Archive content type
contentTypeSchema: {
    get: () => Promise<ContentTypeCachedSchema>;
    update: (
        mutation?: ContentTypeCachedSchema,
    ) => Promise<ContentTypeCachedSchema>;
}
- get: () => Promise<ContentTypeCachedSchema>
  Get the associated JSON schema document for a content type
- update: (mutation?: ContentTypeCachedSchema) => Promise<ContentTypeCachedSchema>
  Sync a content type with the associated JSON schema document
unarchive: () => Promise<ContentType>
Unarchive content type
update: (mutation: ContentType) => Promise<ContentType>
Update a Content Type with the provided changes

`Optional`settings

settings?: ContentTypeSettings

Object containing display settings for the content type

status

status: Status

Lifecycle status of the content type

Methods

`Protected`performActionWithoutResourceResponse

performActionWithoutResourceResponse(
    name: string,
    params: any,
    data: any,
    method?: POST | PUT | PATCH,
): Promise<void>
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>
Inherited from HalResource.performActionWithoutResourceResponse
- Defined in src/lib/hal/models/HalResource.ts:179

toJson

toJson(): any
Returns a copy of this resource's attributes excluding links and client references

Returns any
Deprecated
Inherited from HalResource.toJson
- Defined in src/lib/hal/models/HalResource.ts:64

toJSON

toJSON(): any
Returns a copy of this resource's attributes excluding links and client references

Returns any
Inherited from HalResource.toJSON
- Defined in src/lib/hal/models/HalResource.ts:52

Class ContentType

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ContentType

Properties

Optional_links

OptionalcontentTypeUri

Optionalid

Readonlyrelated

Type declaration

archive: () => Promise<ContentType>

contentTypeSchema: { get: () => Promise<ContentTypeCachedSchema>; update: ( mutation?: ContentTypeCachedSchema, ) => Promise<ContentTypeCachedSchema>;}

get: () => Promise<ContentTypeCachedSchema>

update: (mutation?: ContentTypeCachedSchema) => Promise<ContentTypeCachedSchema>

unarchive: () => Promise<ContentType>

update: (mutation: ContentType) => Promise<ContentType>

Optionalsettings

status

Methods

ProtectedperformActionWithoutResourceResponse

Parameters

Returns Promise<void>

toJson

Returns any

Deprecated

toJSON

Returns any

Settings

On This Page

`Optional`_links

`Optional`contentTypeUri

`Optional`id

`Readonly`related

contentTypeSchema: {
get: () => Promise<ContentTypeCachedSchema>;
update: (
mutation?: ContentTypeCachedSchema,
) => Promise<ContentTypeCachedSchema>;
}

`Optional`settings

`Protected`performActionWithoutResourceResponse