Developer
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Classes
Enumerations
Interfaces
TypeAliases

CompassApi

Forge api class, scoped to Compass graphQL requests.

Constructors

new CompassApi(api: FetchAPI): CompassApi

1
2
const compassApi = new CompassApi()

Properties

Property NameTypeDescription
apiFetchAPI
asAppRequestsCompassRequests
asUserRequestsCompassRequests
configAsCodeConfigAsCodeAPI

Methods

AsApp

asApp(): CompassRequests

Authenticates with Atlassian GraphQL Gateway as your Forge app.

1
2
const resp = compassApi.asApp()

AsUser

asUser(): CompassRequests

Authenticates with Atlassian GraphQL Gateway as user.

1
2
const resp = compassApi.asUser()

Rate this page: