Class SHOGunAPIClient

Index

Constructors

Methods

application auth cache file getBasePath getKeycloak graphql group imagefile info layer openapi role setBasePath setKeycloak user

Constructors

constructor

new SHOGunAPIClient(opts?): SHOGunAPIClient
Parameters
- opts: SHOGunAPIClientOpts = ...
Returns SHOGunAPIClient
- Defined in service/SHOGunAPIClient.ts:54

Methods

application

application<T>(): ApplicationService<T>
Type Parameters
- T extends default<DefaultApplicationClientConfig<DefaultMapView, DefaultLegalConfig, DefaultApplicationTheme>, DefaultLayerTree, DefaultApplicationLayerConfig<DefaultLayerClientConfig, DefaultLayerSourceConfig>, DefaultApplicationToolConfig>
Returns ApplicationService<T>
- Defined in service/SHOGunAPIClient.ts:83

auth

auth(): AuthService
Returns AuthService
- Defined in service/SHOGunAPIClient.ts:160

cache

cache(): CacheService
Returns CacheService
- Defined in service/SHOGunAPIClient.ts:61

file

file<T>(): FileService<T>
Type Parameters
- T extends default
Returns FileService<T>
- Defined in service/SHOGunAPIClient.ts:138

getBasePath

getBasePath(): string
Returns string
- Defined in service/SHOGunAPIClient.ts:193

getKeycloak

getKeycloak(): undefined | Keycloak
Returns undefined | Keycloak
- Defined in service/SHOGunAPIClient.ts:201

graphql

graphql(): GraphQLService
Returns GraphQLService
- Defined in service/SHOGunAPIClient.ts:171

group

group<T, S>(): GroupService<T, S>
Type Parameters
- T extends default<S>
- S extends ProviderGroupDetails
Returns GroupService<T, S>
- Defined in service/SHOGunAPIClient.ts:105

imagefile

imagefile<T>(): ImageFileService<T>
Type Parameters
- T extends default
Returns ImageFileService<T>
- Defined in service/SHOGunAPIClient.ts:149

info

info(): AppInfoService
Returns AppInfoService
- Defined in service/SHOGunAPIClient.ts:72

layer

layer<T>(): LayerService<T>
Type Parameters
- T extends default<DefaultLayerClientConfig, DefaultLayerSourceConfig>
Returns LayerService<T>
- Defined in service/SHOGunAPIClient.ts:94

openapi

openapi(): OpenAPIService
Returns OpenAPIService
- Defined in service/SHOGunAPIClient.ts:182

role

role<T, S>(): RoleService<T, S>
Type Parameters
- T extends default<S>
- S extends ProviderRoleDetails
Returns RoleService<T, S>
- Defined in service/SHOGunAPIClient.ts:127

setBasePath

setBasePath(basePath): void
Parameters
- basePath: string
Returns void
- Defined in service/SHOGunAPIClient.ts:197

setKeycloak

setKeycloak(keycloak): void
Parameters
- keycloak: Keycloak
Returns void
- Defined in service/SHOGunAPIClient.ts:205

user

user<T, S>(): UserService<T, S>
Type Parameters
- T extends default<S>
- S extends ProviderUserDetails
Returns UserService<T, S>
- Defined in service/SHOGunAPIClient.ts:116