Class ContentSchema

Hierarchy

ContentSchema

Index

Constructors

constructor

Properties

schema

Methods

Constructors

constructor

new ContentSchema(config: SquidexClientConfiguration, httpClient: HttpClient, authenticationManager: AuthenticationManager): ContentSchema

- Defined in schemas/content.ts:10
Parameters
- config: SquidexClientConfiguration
- httpClient: HttpClient
- authenticationManager: AuthenticationManager
Returns ContentSchema

Properties

schema

schema: string

Methods

create

create<T, R>(content: T, publish?: boolean): Promise<SquidexContent<R>>

- Defined in schemas/content.ts:62
Creates a new content item

Type parameters
- T
- R
Parameters
- content: T
- Default value publish: boolean = false
  
  whether to publish the content item immediately
Returns Promise<SquidexContent<R>>

delete

delete<T>(id: string): Promise<boolean>

- Defined in schemas/content.ts:119
Deletes a content item

Type parameters
- T
Parameters
- id: string
  
  ID of the content item
Returns Promise<boolean>

discard

discard<T>(id: string): Promise<SquidexContent<T>>

- Defined in schemas/content.ts:165
Discards changes to a content item

Type parameters
- T
Parameters
- id: string
  
  ID of the content item
Returns Promise<SquidexContent<T>>

patch

patch<T>(id: string, content: Partial<T>): Promise<SquidexContent<T>>

- Defined in schemas/content.ts:100
Patches a content item

Type parameters
- T
Parameters
- id: string
  
  ID of the content item
- content: Partial<T>
Returns Promise<SquidexContent<T>>

query

query<T>(query?: SquidexQuery, draft?: boolean): Promise<SquidexContentCollection<SquidexContent<T>>>

- Defined in schemas/content.ts:22
Returns all content from the API matching query Set draft to true to return content in draft

Type parameters
- T
Parameters
- Default value query: SquidexQuery = {}
- Default value draft: boolean = false
Returns Promise<SquidexContentCollection<SquidexContent<T>>>

querySingle

querySingle<T>(query?: SquidexQuery, draft?: boolean): Promise<SquidexContent<T>>

- Defined in schemas/content.ts:47
Returns the first content item from the API matching query Set draft to true to return content in draft

Type parameters
- T
Parameters
- Default value query: SquidexQuery = {}
- Default value draft: boolean = false
Returns Promise<SquidexContent<T>>

update

update<T>(id: string, content: T): Promise<SquidexContent<T>>

- Defined in schemas/content.ts:81
Updates a content item

Type parameters
- T
Parameters
- id: string
  
  ID of the content item
- content: T
Returns Promise<SquidexContent<T>>

updateStatus

updateStatus<T>(id: string, status: SquidexStatusUpdate): Promise<SquidexContent<T>>

- Defined in schemas/content.ts:138
Updates the status of a content item

Type parameters
- T
Parameters
- id: string
  
  ID of the content item
- status: SquidexStatusUpdate
  
  the new status
Returns Promise<SquidexContent<T>>

Generated using TypeDoc