Skip to main content
Skip to main content

OauthService

Constructors

constructor

**new OauthService**(cradle)

Parameters

cradleInjectedDependenciesRequired

Properties

__configModule__Record<string, unknown>
__container__anyRequired
__moduleDeclaration__Record<string, unknown>
container_InjectedDependenciesRequired
eventBus_EventBusServiceRequired
manager_EntityManagerRequired
oauthRepository_Repository<Oauth>Required
transactionManager_undefined | EntityManagerRequired
EventsobjectRequired
Events.TOKEN_GENERATEDstringRequired

Default: "oauth.token_generated"

Events.TOKEN_REFRESHEDstringRequired

Default: "oauth.token_refreshed"

Accessors

activeManager_

Protected get**activeManager_**(): EntityManager

Returns

EntityManager

EntityManagerEntityManagerRequired

Methods

atomicPhase_

Protected **atomicPhase_**<TypeParameter TResult, TypeParameter TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise&#60;TResult&#62;

Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.

TResultobjectRequired
TErrorobjectRequired

Parameters

work(transactionManager: EntityManager) => Promise<TResult>Required
the transactional work to be done
isolationOrErrorHandlerIsolationLevel | (error: TError) => Promise<void | TResult>
the isolation level to be used for the work.
maybeErrorHandlerOrDontFail(error: TError) => Promise<void | TResult>
Potential error handler

Returns

Promise<TResult>

PromisePromise<TResult>Required
the result of the transactional work

create

**create**(data): Promise&#60;[Oauth](/references/services/classes/Oauth)&#62;

Parameters

dataCreateOauthInputRequired

Returns

Promise<Oauth>

PromisePromise<Oauth>Required

generateToken

**generateToken**(appName, code, state): Promise&#60;[Oauth](/references/services/classes/Oauth)&#62;

Parameters

appNamestringRequired
codestringRequired
statestringRequired

Returns

Promise<Oauth>

PromisePromise<Oauth>Required

list

**list**(selector): Promise&#60;[Oauth](/references/services/classes/Oauth)[]&#62;

Parameters

selectorSelector<Oauth>Required

Returns

Promise<Oauth[]>

PromisePromise<Oauth[]>Required

refreshToken

**refreshToken**(appName): Promise&#60;[Oauth](/references/services/classes/Oauth)&#62;

Parameters

appNamestringRequired

Returns

Promise<Oauth>

PromisePromise<Oauth>Required

registerOauthApp

**registerOauthApp**(appDetails): Promise&#60;[Oauth](/references/services/classes/Oauth)&#62;

Parameters

appDetailsCreateOauthInputRequired

Returns

Promise<Oauth>

PromisePromise<Oauth>Required

retrieve

**retrieve**(oauthId): Promise&#60;[Oauth](/references/services/classes/Oauth)&#62;

Parameters

oauthIdstringRequired

Returns

Promise<Oauth>

PromisePromise<Oauth>Required

retrieveByName

**retrieveByName**(appName): Promise&#60;[Oauth](/references/services/classes/Oauth)&#62;

Parameters

appNamestringRequired

Returns

Promise<Oauth>

PromisePromise<Oauth>Required

shouldRetryTransaction_

Protected **shouldRetryTransaction_**(err): boolean

Parameters

errRecord<string, unknown> | { code: string }Required

Returns

boolean

booleanboolean

update

**update**(id, update): Promise&#60;[Oauth](/references/services/classes/Oauth)&#62;

Parameters

idstringRequired
updateUpdateOauthInputRequired

Returns

Promise<Oauth>

PromisePromise<Oauth>Required

withTransaction

**withTransaction**(transactionManager?): [OauthService](/references/services/classes/OauthService)

Parameters

transactionManagerEntityManager

Returns

OauthService

OauthOauthServiceRequired
Was this section helpful?