Class GroupsEndpointAdmin

An endpoint for working with Knora groups.

Hierarchy

Endpoint
- GroupsEndpointAdmin

Index

Constructors

constructor

Properties

Accessors

jsonWebToken

Methods

Constructors

constructor

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

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

Parameters
- knoraApiConfig: KnoraApiConfig
- path: string
Returns GroupsEndpointAdmin

Properties

jsonConvert

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

JsonConvert instance

Protected knoraApiConfig

knoraApiConfig: KnoraApiConfig

Protected path

path: string

Accessors

jsonWebToken

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

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

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

Parameters
- value: string
Returns void

Methods

createGroup

createGroup(group: CreateGroupRequest): Observable<ApiResponseData<GroupResponse> | ApiResponseError>

- Defined in src/api/admin/groups/groups-endpoint-admin.ts:39
Creates a group.

Parameters
- group: CreateGroupRequest
  
  The group to be created.
Returns Observable<ApiResponseData<GroupResponse> | ApiResponseError>

deleteGroup

deleteGroup(iri: string): Observable<ApiResponseData<GroupResponse> | ApiResponseError>

- Defined in src/api/admin/groups/groups-endpoint-admin.ts:97
Deletes a group. This method does not actually delete a group, but sets the status to false.

Parameters
- iri: string
  
  The IRI of the group.
Returns Observable<ApiResponseData<GroupResponse> | ApiResponseError>

getGroupByIri

getGroupByIri(iri: string): Observable<ApiResponseData<GroupResponse> | ApiResponseError>

- Defined in src/api/admin/groups/groups-endpoint-admin.ts:53
Gets a group by IRI.

Parameters
- iri: string
  
  The IRI of the group.
Returns Observable<ApiResponseData<GroupResponse> | ApiResponseError>

getGroupMembers

getGroupMembers(iri: string): Observable<ApiResponseData<MembersResponse> | ApiResponseError>

- Defined in src/api/admin/groups/groups-endpoint-admin.ts:111
Gets the members of a group.

Parameters
- iri: string
  
  The IRI of the group.
Returns Observable<ApiResponseData<MembersResponse> | ApiResponseError>

getGroups

getGroups(): Observable<ApiResponseData<GroupsResponse> | ApiResponseError>

- Defined in src/api/admin/groups/groups-endpoint-admin.ts:25
Returns a list of all groups.

Returns Observable<ApiResponseData<GroupsResponse> | ApiResponseError>

Protected handleError

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

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

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

Protected httpDelete

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

Inherited from Endpoint.httpDelete
- Defined in src/api/endpoint.ts:138
Performs a general PUT request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
Returns Observable<AjaxResponse>

Protected httpGet

httpGet(path?: undefined | string): Observable<AjaxResponse>

Inherited from Endpoint.httpGet
- Defined in src/api/endpoint.ts:80
Performs a general GET request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
Returns Observable<AjaxResponse>

Protected httpPatch

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

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

Protected httpPost

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

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

Protected httpPut

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

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

updateGroup

updateGroup(iri: string, groupInfo: UpdateGroupRequest): Observable<ApiResponseData<GroupResponse> | ApiResponseError>

- Defined in src/api/admin/groups/groups-endpoint-admin.ts:68
Updates a group.

Parameters
- iri: string
  
  The IRI of the group to be updated.
- groupInfo: UpdateGroupRequest
  
  The group information to be updated.
Returns Observable<ApiResponseData<GroupResponse> | ApiResponseError>

updateGroupStatus

updateGroupStatus(iri: string, status: boolean): Observable<ApiResponseData<GroupResponse> | ApiResponseError>

- Defined in src/api/admin/groups/groups-endpoint-admin.ts:83
Updates the status of a group.

Parameters
- iri: string
  
  The IRI of the group to be updated.
- status: boolean
  
  The new status of the group.
Returns Observable<ApiResponseData<GroupResponse> | ApiResponseError>

Generated using TypeDoc