Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AdminEndpoint

A client API for administering Knora.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

delay

delay: 500 = 500

groupsEndpoint

groupsEndpoint: GroupsEndpointAdmin

An endpoint for working with Knora groups.

jsonConvert

jsonConvert: JsonConvert = new JsonConvert(OperationMode.ENABLE,ValueCheckingMode.DISALLOW_NULL,false,PropertyMatchingRule.CASE_STRICT)

JsonConvert instance

Protected knoraApiConfig

knoraApiConfig: KnoraApiConfig

listsEndpoint

listsEndpoint: ListsEndpointAdmin

An endpoint for working with Knora lists.

maxRetries

maxRetries: 5 = 5

Protected path

path: string

permissionsEndpoint

permissionsEndpoint: PermissionsEndpointAdmin

An endpoint for working with Knora permissions.

projectsEndpoint

projectsEndpoint: ProjectsEndpointAdmin

An endpoint for working with Knora projects.

retryOnErrorStatus

retryOnErrorStatus: number[] = [0, 500]

usersEndpoint

usersEndpoint: UsersEndpointAdmin

An endpoint for working with Knora users.

Accessors

jsonWebToken

  • get jsonWebToken(): string
  • set jsonWebToken(value: string): void

Methods

Protected handleError

Protected httpDelete

  • httpDelete(path?: undefined | string, headerOpts?: IHeaderOptions): Observable<AjaxResponse>

  • Performs a general PUT request.

    Parameters

    • Optional path: undefined | string

      the relative URL for the request.

    • Optional headerOpts: IHeaderOptions

      additional headers, if any.

    Returns Observable<AjaxResponse>

Protected httpGet

  • httpGet(path?: undefined | string, headerOpts?: IHeaderOptions): Observable<AjaxResponse>

  • Performs a general GET request.

    Parameters

    • Optional path: undefined | string

      the relative URL for the request

    • Optional headerOpts: IHeaderOptions

      additional headers, if any.

    Returns Observable<AjaxResponse>

Protected httpPatch

  • httpPatch(path?: undefined | string, body?: any, contentType?: "json", headerOpts?: IHeaderOptions): Observable<AjaxResponse>

  • Performs a general PATCH request.

    Parameters

    • Optional path: undefined | string

      the relative URL for the request

    • Optional body: any

      the body of the request

    • Default value contentType: "json" = "json"

      content content type of body, if any.

    • Optional headerOpts: IHeaderOptions

      additional headers, if any.

    Returns Observable<AjaxResponse>

Protected httpPost

  • httpPost(path?: undefined | string, body?: any, contentType?: "json" | "sparql", headerOpts?: IHeaderOptions): Observable<AjaxResponse>

  • Performs a general POST request.

    Parameters

    • Optional path: undefined | string

      the relative URL for the request

    • Optional body: any

      the body of the request, if any.

    • Default value contentType: "json" | "sparql" = "json"

      content content type of body, if any.

    • Optional headerOpts: IHeaderOptions

      additional headers, if any.

    Returns Observable<AjaxResponse>

Protected httpPut

  • httpPut(path?: undefined | string, body?: any, contentType?: "json", headerOpts?: IHeaderOptions): Observable<AjaxResponse>

  • Performs a general PUT request.

    Parameters

    • Optional path: undefined | string

      the relative URL for the request

    • Optional body: any

      the body of the request

    • Default value contentType: "json" = "json"

      content content type of body, if any.

    • Optional headerOpts: IHeaderOptions

      additional headers, if any.

    Returns Observable<AjaxResponse>

Generated using TypeDoc