Class: OauthService
Hierarchy
TransactionBaseService
Copy to Clipboard↳
OauthService
Copy to Clipboard
Constructors
constructor
• new OauthService(cradle
Copy to Clipboard)
Parameters
Name | Type |
---|---|
cradle Copy to Clipboard | InjectedDependencies Copy to Clipboard |
Overrides
TransactionBaseService.constructor
Defined in
packages/medusa/src/services/oauth.ts:31
Properties
__configModule__
• Protected
Copy to Clipboard Optional
Copy to Clipboard Readonly
Copy to Clipboard __configModule__: Record
Copy to Clipboard<string
Copy to Clipboard, unknown
Copy to Clipboard>
Inherited from
TransactionBaseService.__configModule__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:10
__container__
• Protected
Copy to Clipboard Readonly
Copy to Clipboard __container__: any
Copy to Clipboard
Inherited from
TransactionBaseService.__container__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:9
__moduleDeclaration__
• Protected
Copy to Clipboard Optional
Copy to Clipboard Readonly
Copy to Clipboard __moduleDeclaration__: Record
Copy to Clipboard<string
Copy to Clipboard, unknown
Copy to Clipboard>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:11
container_
• Protected
Copy to Clipboard container_: InjectedDependencies
Copy to Clipboard
Defined in
packages/medusa/src/services/oauth.ts:27
eventBus_
• Protected
Copy to Clipboard eventBus_: EventBusService
Copy to Clipboard
Defined in
packages/medusa/src/services/oauth.ts:29
manager
• Protected
Copy to Clipboard manager: EntityManager
Copy to Clipboard
Defined in
packages/medusa/src/services/oauth.ts:26
manager_
• Protected
Copy to Clipboard manager_: EntityManager
Copy to Clipboard
Overrides
TransactionBaseService.manager_
Defined in
packages/medusa/src/services/oauth.ts:19
oauthRepository_
• Protected
Copy to Clipboard oauthRepository_: typeof OauthRepository
Copy to Clipboard
Defined in
packages/medusa/src/services/oauth.ts:28
transactionManager_
• Protected
Copy to Clipboard transactionManager_: undefined
Copy to Clipboard | EntityManager
Copy to Clipboard
Overrides
TransactionBaseService.transactionManager_
Defined in
packages/medusa/src/services/oauth.ts:20
Events
▪ Static
Copy to Clipboard Events: Object
Copy to Clipboard
Type declaration
Name | Type |
---|---|
TOKEN_GENERATED Copy to Clipboard | string Copy to Clipboard |
TOKEN_REFRESHED Copy to Clipboard | string Copy to Clipboard |
Defined in
packages/medusa/src/services/oauth.ts:21
Methods
atomicPhase_
▸ Protected
Copy to Clipboard atomicPhase_<TResult
Copy to Clipboard, TError
Copy to Clipboard>(work
Copy to Clipboard, isolationOrErrorHandler?
Copy to Clipboard, maybeErrorHandlerOrDontFail?
Copy to Clipboard): Promise
Copy to Clipboard<TResult
Copy to Clipboard>
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 Copy to Clipboard |
TError Copy to Clipboard |
Parameters
Name | Type | Description |
---|---|---|
work Copy to Clipboard | (transactionManager Copy to Clipboard: EntityManager Copy to Clipboard) => Promise Copy to Clipboard<TResult Copy to Clipboard> | the transactional work to be done |
isolationOrErrorHandler? Copy to Clipboard | IsolationLevel Copy to Clipboard | (error Copy to Clipboard: TError Copy to Clipboard) => Promise Copy to Clipboard<void Copy to Clipboard | TResult Copy to Clipboard> | the isolation level to be used for the work. |
maybeErrorHandlerOrDontFail? Copy to Clipboard | (error Copy to Clipboard: TError Copy to Clipboard) => Promise Copy to Clipboard<void Copy to Clipboard | TResult Copy to Clipboard> | Potential error handler |
Returns
Promise
Copy to Clipboard<TResult
Copy to Clipboard>
the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:50
create
▸ create(data
Copy to Clipboard): Promise
Copy to Clipboard<Oauth
Copy to Clipboard>
Parameters
Name | Type |
---|---|
data Copy to Clipboard | CreateOauthInput Copy to Clipboard |
Returns
Promise
Copy to Clipboard<Oauth
Copy to Clipboard>
Defined in
packages/medusa/src/services/oauth.ts:88
generateToken
▸ generateToken(appName
Copy to Clipboard, code
Copy to Clipboard, state
Copy to Clipboard): Promise
Copy to Clipboard<Oauth
Copy to Clipboard>
Parameters
Name | Type |
---|---|
appName Copy to Clipboard | string Copy to Clipboard |
code Copy to Clipboard | string Copy to Clipboard |
state Copy to Clipboard | string Copy to Clipboard |
Returns
Promise
Copy to Clipboard<Oauth
Copy to Clipboard>
Defined in
packages/medusa/src/services/oauth.ts:122
list
▸ list(selector
Copy to Clipboard): Promise
Copy to Clipboard<Oauth
Copy to Clipboard[]>
Parameters
Name | Type |
---|---|
selector Copy to Clipboard | Selector Copy to Clipboard<Oauth Copy to Clipboard> |
Returns
Promise
Copy to Clipboard<Oauth
Copy to Clipboard[]>
Defined in
packages/medusa/src/services/oauth.ts:80
refreshToken
▸ refreshToken(appName
Copy to Clipboard): Promise
Copy to Clipboard<Oauth
Copy to Clipboard>
Parameters
Name | Type |
---|---|
appName Copy to Clipboard | string Copy to Clipboard |
Returns
Promise
Copy to Clipboard<Oauth
Copy to Clipboard>
Defined in
packages/medusa/src/services/oauth.ts:156
registerOauthApp
▸ registerOauthApp(appDetails
Copy to Clipboard): Promise
Copy to Clipboard<Oauth
Copy to Clipboard>
Parameters
Name | Type |
---|---|
appDetails Copy to Clipboard | CreateOauthInput Copy to Clipboard |
Returns
Promise
Copy to Clipboard<Oauth
Copy to Clipboard>
Defined in
packages/medusa/src/services/oauth.ts:112
retrieve
▸ retrieve(oauthId
Copy to Clipboard): Promise
Copy to Clipboard<Oauth
Copy to Clipboard>
Parameters
Name | Type |
---|---|
oauthId Copy to Clipboard | string Copy to Clipboard |
Returns
Promise
Copy to Clipboard<Oauth
Copy to Clipboard>
Defined in
packages/medusa/src/services/oauth.ts:57
retrieveByName
▸ retrieveByName(appName
Copy to Clipboard): Promise
Copy to Clipboard<Oauth
Copy to Clipboard>
Parameters
Name | Type |
---|---|
appName Copy to Clipboard | string Copy to Clipboard |
Returns
Promise
Copy to Clipboard<Oauth
Copy to Clipboard>
Defined in
packages/medusa/src/services/oauth.ts:41
shouldRetryTransaction_
▸ Protected
Copy to Clipboard shouldRetryTransaction_(err
Copy to Clipboard): boolean
Copy to Clipboard
Parameters
Name | Type |
---|---|
err Copy to Clipboard | Record Copy to Clipboard<string Copy to Clipboard, unknown Copy to Clipboard> | { code Copy to Clipboard: string Copy to Clipboard } |
Returns
boolean
Copy to Clipboard
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:31
update
▸ update(id
Copy to Clipboard, update
Copy to Clipboard): Promise
Copy to Clipboard<Oauth
Copy to Clipboard>
Parameters
Name | Type |
---|---|
id Copy to Clipboard | string Copy to Clipboard |
update Copy to Clipboard | UpdateOauthInput Copy to Clipboard |
Returns
Promise
Copy to Clipboard<Oauth
Copy to Clipboard>
Defined in
packages/medusa/src/services/oauth.ts:101
withTransaction
▸ withTransaction(transactionManager?
Copy to Clipboard): OauthService
Copy to Clipboard
Parameters
Name | Type |
---|---|
transactionManager? Copy to Clipboard | EntityManager Copy to Clipboard |
Returns
Inherited from
TransactionBaseService.withTransaction
Defined in
packages/medusa/src/interfaces/transaction-base-service.ts:14