8.0 KiB
Class: OauthService
Hierarchy
-
TransactionBaseService↳
OauthService
Constructors
constructor
• new OauthService(cradle)
Parameters
| Name | Type |
|---|---|
cradle |
InjectedDependencies |
Overrides
TransactionBaseService.constructor
Defined in
packages/medusa/src/services/oauth.ts:31
Properties
__configModule__
• Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.__configModule__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:10
__container__
• Protected Readonly __container__: any
Inherited from
TransactionBaseService.__container__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:9
container_
• Protected container_: InjectedDependencies
Defined in
packages/medusa/src/services/oauth.ts:27
eventBus_
• Protected eventBus_: EventBusService
Defined in
packages/medusa/src/services/oauth.ts:29
manager
• Protected manager: EntityManager
Defined in
packages/medusa/src/services/oauth.ts:26
manager_
• Protected manager_: EntityManager
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/oauth.ts:19
oauthRepository_
• Protected oauthRepository_: typeof OauthRepository
Defined in
packages/medusa/src/services/oauth.ts:28
transactionManager_
• Protected transactionManager_: undefined | EntityManager
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/oauth.ts:20
Events
▪ Static Events: Object
Type declaration
| Name | Type |
|---|---|
TOKEN_GENERATED |
string |
TOKEN_REFRESHED |
string |
Defined in
packages/medusa/src/services/oauth.ts:21
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
| Name | Type | Description |
|---|---|---|
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
packages/medusa/src/interfaces/transaction-base-service.ts:50
create
▸ create(data): Promise<Oauth>
Parameters
| Name | Type |
|---|---|
data |
CreateOauthInput |
Returns
Promise<Oauth>
Defined in
packages/medusa/src/services/oauth.ts:81
generateToken
▸ generateToken(appName, code, state): Promise<Oauth>
Parameters
| Name | Type |
|---|---|
appName |
string |
code |
string |
state |
string |
Returns
Promise<Oauth>
Defined in
packages/medusa/src/services/oauth.ts:119
list
▸ list(selector): Promise<Oauth[]>
Parameters
| Name | Type |
|---|---|
selector |
Selector<Oauth> |
Returns
Promise<Oauth[]>
Defined in
packages/medusa/src/services/oauth.ts:73
refreshToken
▸ refreshToken(appName): Promise<Oauth>
Parameters
| Name | Type |
|---|---|
appName |
string |
Returns
Promise<Oauth>
Defined in
packages/medusa/src/services/oauth.ts:153
registerOauthApp
▸ registerOauthApp(appDetails): Promise<Oauth>
Parameters
| Name | Type |
|---|---|
appDetails |
CreateOauthInput |
Returns
Promise<Oauth>
Defined in
packages/medusa/src/services/oauth.ts:109
retrieve
▸ retrieve(oauthId): Promise<Oauth>
Parameters
| Name | Type |
|---|---|
oauthId |
string |
Returns
Promise<Oauth>
Defined in
packages/medusa/src/services/oauth.ts:57
retrieveByName
▸ retrieveByName(appName): Promise<Oauth>
Parameters
| Name | Type |
|---|---|
appName |
string |
Returns
Promise<Oauth>
Defined in
packages/medusa/src/services/oauth.ts:41
shouldRetryTransaction_
▸ Protected shouldRetryTransaction_(err): boolean
Parameters
| Name | Type |
|---|---|
err |
Record<string, unknown> | { code: string } |
Returns
boolean
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:31
update
▸ update(id, update): Promise<Oauth>
Parameters
| Name | Type |
|---|---|
id |
string |
update |
UpdateOauthInput |
Returns
Promise<Oauth>
Defined in
packages/medusa/src/services/oauth.ts:96
withTransaction
▸ withTransaction(transactionManager?): OauthService
Parameters
| Name | Type |
|---|---|
transactionManager? |
EntityManager |
Returns
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:13