Skip to content
Last updated

PERS SDK - v2.3.26 / Exports / UserStatusService

Class: UserStatusService

Platform-Agnostic User Status Service

Contains user status business logic and operations that work across platforms. No framework dependencies - pure TypeScript business logic. Matches framework UserStatusApiService capabilities exactly.

Table of contents

Constructors

Methods

Constructors

constructor

• new UserStatusService(userStatusApi): UserStatusService

Parameters

NameType
userStatusApiUserStatusApi

Returns

UserStatusService

Defined in

user-status/services/user-status-service.ts:14

Methods

getRemoteUserStatusTypes

▸ getRemoteUserStatusTypes(options?): Promise<PaginatedResponseDTO<UserStatusTypeDTO>>

PUBLIC: Get remote user status types

Parameters

NameType
options?PaginationOptions

Returns

Promise<PaginatedResponseDTO<UserStatusTypeDTO>>

Defined in

user-status/services/user-status-service.ts:23


getRemoteEarnedUserStatus

▸ getRemoteEarnedUserStatus(options?): Promise<PaginatedResponseDTO<UserStatusTypeDTO>>

AUTH: Get earned user status for authenticated user

Parameters

NameType
options?PaginationOptions

Returns

Promise<PaginatedResponseDTO<UserStatusTypeDTO>>

Defined in

user-status/services/user-status-service.ts:34


createUserStatusType

▸ createUserStatusType(userStatusType): Promise<UserStatusTypeDTO>

ADMIN: Create user status type

Parameters

NameType
userStatusTypeUserStatusTypeDTO

Returns

Promise<UserStatusTypeDTO>

Defined in

user-status/services/user-status-service.ts:45


updateUserStatusType

▸ updateUserStatusType(id, userStatusType): Promise<UserStatusTypeDTO>

ADMIN: Update user status type

Parameters

NameType
idnumber
userStatusTypeUserStatusTypeDTO

Returns

Promise<UserStatusTypeDTO>

Defined in

user-status/services/user-status-service.ts:52


deleteUserStatusType

▸ deleteUserStatusType(id): Promise<void>

ADMIN: Delete user status type

Parameters

NameType
idnumber

Returns

Promise<void>

Defined in

user-status/services/user-status-service.ts:59