PermissionsEndpointAdmin | @dasch-swiss/dsp-js API Documentation

An endpoint for working with Knora permissions.

Hierarchy

Endpoint
- PermissionsEndpointAdmin

Index

Constructors

constructor

Properties

Accessors

jsonWebToken

Methods

Constructors

constructor

new PermissionsEndpointAdmin(knoraApiConfig: KnoraApiConfig, path: string): PermissionsEndpointAdmin

Inherited from Endpoint.constructor
- Defined in src/api/endpoint.ts:56
Constructor.

Parameters
- knoraApiConfig: KnoraApiConfig
- path: string
Returns PermissionsEndpointAdmin

Properties

delay

delay: 500 = 500

jsonConvert

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

JsonConvert instance

Protected knoraApiConfig

knoraApiConfig: KnoraApiConfig

maxRetries

maxRetries: 5 = 5

Protected path

path: string

retryOnErrorStatus

retryOnErrorStatus: number[] = [0, 500]

Accessors

jsonWebToken

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

Inherited from Endpoint.jsonWebToken
- Defined in src/api/endpoint.ts:47
The session token

Returns string
Inherited from Endpoint.jsonWebToken
- Defined in src/api/endpoint.ts:54
The session token

Parameters
- value: string
Returns void

Methods

createAdministrativePermission

createAdministrativePermission(administrativePermission: CreateAdministrativePermission): Observable<ApiResponseError | ApiResponseData<AdministrativePermissionResponse>>

- Defined in src/api/admin/permissions/permissions-endpoint-admin.ts:69
Creates an administrative permission.

Parameters
- administrativePermission: CreateAdministrativePermission
  
  the administrative permission to be created.
Returns Observable<ApiResponseError | ApiResponseData<AdministrativePermissionResponse>>

createDefaultObjectAccessPermission

createDefaultObjectAccessPermission(defaultObjectAccessPermission: CreateDefaultObjectAccessPermission): Observable<ApiResponseError | ApiResponseData<DefaultObjectAccessPermissionResponse>>

- Defined in src/api/admin/permissions/permissions-endpoint-admin.ts:105
Creates a default object access permission.

Parameters
- defaultObjectAccessPermission: CreateDefaultObjectAccessPermission
  
  the permission to be created.
Returns Observable<ApiResponseError | ApiResponseData<DefaultObjectAccessPermissionResponse>>

deletePermission

deletePermission(permissionIri: string): Observable<ApiResponseError | ApiResponseData<DeletePermissionResponse>>

- Defined in src/api/admin/permissions/permissions-endpoint-admin.ts:142
Deletes a permission.

Parameters
- permissionIri: string
  
  the IRI of the permission to be deleted.
Returns Observable<ApiResponseError | ApiResponseData<DeletePermissionResponse>>

getAdministrativePermission

getAdministrativePermission(projectIri: string, groupIri: string): Observable<ApiResponseData<AdministrativePermissionResponse> | ApiResponseError>

- Defined in src/api/admin/permissions/permissions-endpoint-admin.ts:55
Gets the administrative permission for a project and group.

Parameters
- projectIri: string
  
  The project IRI.
- groupIri: string
  
  The group IRI.
Returns Observable<ApiResponseData<AdministrativePermissionResponse> | ApiResponseError>

getAdministrativePermissions

getAdministrativePermissions(projectIri: string): Observable<ApiResponseData<AdministrativePermissionsResponse> | ApiResponseError>

- Defined in src/api/admin/permissions/permissions-endpoint-admin.ts:40
Gets the administrative permissions for a project.

Parameters
- projectIri: string
  
  The project IRI.
Returns Observable<ApiResponseData<AdministrativePermissionsResponse> | ApiResponseError>

getDefaultObjectAccessPermissions

getDefaultObjectAccessPermissions(projectIri: string): Observable<ApiResponseError | ApiResponseData<DefaultObjectAccessPermissionsResponse>>

- Defined in src/api/admin/permissions/permissions-endpoint-admin.ts:91
Gets all default object access permissions for a project.

Parameters
- projectIri: string
  
  The project IRI.
Returns Observable<ApiResponseError | ApiResponseData<DefaultObjectAccessPermissionsResponse>>

getProjectPermissions

getProjectPermissions(projectIri: string): Observable<ApiResponseError | ApiResponseData<ProjectPermissionsResponse>>

- Defined in src/api/admin/permissions/permissions-endpoint-admin.ts:27
Gets the permissions for a project.

Parameters
- projectIri: string
  
  The project IRI.
Returns Observable<ApiResponseError | ApiResponseData<ProjectPermissionsResponse>>

Protected handleError

handleError(error: AjaxError | DataError): Observable<ApiResponseError>

Inherited from Endpoint.handleError
- Defined in src/api/endpoint.ts:159
Handles parsing errors.

Parameters
- error: AjaxError | DataError
  
  the error class provided by us
Returns Observable<ApiResponseError>

Protected httpDelete

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

Inherited from Endpoint.httpDelete
- Defined in src/api/endpoint.ts:144
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>

Inherited from Endpoint.httpGet
- Defined in src/api/endpoint.ts:70
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>

Inherited from Endpoint.httpPatch
- Defined in src/api/endpoint.ts:127
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>

Inherited from Endpoint.httpPost
- Defined in src/api/endpoint.ts:89
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>

Inherited from Endpoint.httpPut
- Defined in src/api/endpoint.ts:108
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>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

knoraApiConfig: KnoraApiConfig

path: string

Returns PermissionsEndpointAdmin

Properties

delay

jsonConvert

Protected knoraApiConfig

maxRetries

Protected path

retryOnErrorStatus

Accessors

jsonWebToken

Returns string

Parameters

value: string

Returns void

Methods

createAdministrativePermission

Parameters

administrativePermission: CreateAdministrativePermission

Returns Observable<ApiResponseError | ApiResponseData<AdministrativePermissionResponse>>

createDefaultObjectAccessPermission

Parameters

defaultObjectAccessPermission: CreateDefaultObjectAccessPermission

Returns Observable<ApiResponseError | ApiResponseData<DefaultObjectAccessPermissionResponse>>

deletePermission

Parameters

permissionIri: string

Returns Observable<ApiResponseError | ApiResponseData<DeletePermissionResponse>>

getAdministrativePermission

Parameters

projectIri: string

groupIri: string

Returns Observable<ApiResponseData<AdministrativePermissionResponse> | ApiResponseError>

getAdministrativePermissions

Parameters

projectIri: string

Returns Observable<ApiResponseData<AdministrativePermissionsResponse> | ApiResponseError>

getDefaultObjectAccessPermissions

Parameters

projectIri: string

Returns Observable<ApiResponseError | ApiResponseData<DefaultObjectAccessPermissionsResponse>>

getProjectPermissions

Parameters

projectIri: string

Returns Observable<ApiResponseError | ApiResponseData<ProjectPermissionsResponse>>

Protected handleError

Parameters

error: AjaxError | DataError

Returns Observable<ApiResponseError>

Protected httpDelete

Parameters

Optional path: undefined | string

Optional headerOpts: IHeaderOptions

Returns Observable<AjaxResponse>

Protected httpGet

Parameters

Optional path: undefined | string

Optional headerOpts: IHeaderOptions

Returns Observable<AjaxResponse>

Protected httpPatch

Parameters

Optional path: undefined | string

Optional body: any

Default value contentType: "json" = "json"

Optional headerOpts: IHeaderOptions

Returns Observable<AjaxResponse>

Protected httpPost

Parameters

Optional path: undefined | string

Optional body: any