Skip to main content

Class: OauthService

Hierarchy​

  • TransactionBaseService

    ↳ OauthService

Constructors​

constructor​

• new OauthService(cradle)

Parameters​

NameType
cradleInjectedDependencies

Overrides​

TransactionBaseService.constructor

Defined in​

medusa/src/services/oauth.ts:28

Properties​

__configModule__​

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from​

TransactionBaseService.__configModule__

Defined in​

medusa/src/interfaces/transaction-base-service.ts:14


__container__​

• Protected Readonly __container__: any

Inherited from​

TransactionBaseService.__container__

Defined in​

medusa/src/interfaces/transaction-base-service.ts:13


__moduleDeclaration__​

• Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>

Inherited from​

TransactionBaseService.__moduleDeclaration__

Defined in​

medusa/src/interfaces/transaction-base-service.ts:15


container_​

• Protected container_: InjectedDependencies

Defined in​

medusa/src/services/oauth.ts:24


eventBus_​

• Protected eventBus_: EventBusService

Defined in​

medusa/src/services/oauth.ts:26


manager_​

• Protected manager_: EntityManager

Inherited from​

TransactionBaseService.manager_

Defined in​

medusa/src/interfaces/transaction-base-service.ts:5


oauthRepository_​

• Protected oauthRepository_: Repository<Oauth>

Defined in​

medusa/src/services/oauth.ts:25


transactionManager_​

• Protected transactionManager_: undefined | EntityManager

Inherited from​

TransactionBaseService.transactionManager_

Defined in​

medusa/src/interfaces/transaction-base-service.ts:6


Events​

▪ Static Events: Object

Type declaration​

NameType
TOKEN_GENERATEDstring
TOKEN_REFRESHEDstring

Defined in​

medusa/src/services/oauth.ts:19

Accessors​

activeManager_​

• Protected get activeManager_(): EntityManager

Returns​

EntityManager

Inherited from​

TransactionBaseService.activeManager_

Defined in​

medusa/src/interfaces/transaction-base-service.ts:8

Methods​

atomicPhase_​

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

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.

Type parameters​

Name
TResult
TError

Parameters​

NameTypeDescription
work(transactionManager: EntityManager) => Promise<TResult>the transactional work to be done
isolationOrErrorHandler?IsolationLevel | (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>

the result of the transactional work

Inherited from​

TransactionBaseService.atomicPhase_

Defined in​

medusa/src/interfaces/transaction-base-service.ts:56


create​

▸ create(data): Promise<Oauth>

Parameters​

NameType
dataCreateOauthInput

Returns​

Promise<Oauth>

Defined in​

medusa/src/services/oauth.ts:87


generateToken​

▸ generateToken(appName, code, state): Promise<Oauth>

Parameters​

NameType
appNamestring
codestring
statestring

Returns​

Promise<Oauth>

Defined in​

medusa/src/services/oauth.ts:121


list​

▸ list(selector): Promise<Oauth[]>

Parameters​

NameType
selectorSelector<Oauth>

Returns​

Promise<Oauth[]>

Defined in​

medusa/src/services/oauth.ts:79


refreshToken​

▸ refreshToken(appName): Promise<Oauth>

Parameters​

NameType
appNamestring

Returns​

Promise<Oauth>

Defined in​

medusa/src/services/oauth.ts:155


registerOauthApp​

▸ registerOauthApp(appDetails): Promise<Oauth>

Parameters​

NameType
appDetailsCreateOauthInput

Returns​

Promise<Oauth>

Defined in​

medusa/src/services/oauth.ts:111


retrieve​

▸ retrieve(oauthId): Promise<Oauth>

Parameters​

NameType
oauthIdstring

Returns​

Promise<Oauth>

Defined in​

medusa/src/services/oauth.ts:54


retrieveByName​

▸ retrieveByName(appName): Promise<Oauth>

Parameters​

NameType
appNamestring

Returns​

Promise<Oauth>

Defined in​

medusa/src/services/oauth.ts:36


shouldRetryTransaction_​

▸ Protected shouldRetryTransaction_(err): boolean

Parameters​

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

Returns​

boolean

Inherited from​

TransactionBaseService.shouldRetryTransaction_

Defined in​

medusa/src/interfaces/transaction-base-service.ts:37


update​

▸ update(id, update): Promise<Oauth>

Parameters​

NameType
idstring
updateUpdateOauthInput

Returns​

Promise<Oauth>

Defined in​

medusa/src/services/oauth.ts:100


withTransaction​

▸ withTransaction(transactionManager?): OauthService

Parameters​

NameType
transactionManager?EntityManager

Returns​

OauthService

Inherited from​

TransactionBaseService.withTransaction

Defined in​

medusa/src/interfaces/transaction-base-service.ts:20

Was this section helpful?