Class Gis

Index

Methods

domain downloadMobile getConfig getEntityAttributes initialExtent inspection request selectedEntities user workOrder

Methods

domain

domain(domainId: any, getGisData?: boolean): Promise<unknown>
Get domain gis services
Parameters
- domainId: any
  The mobile map cache Id to download
- getGisData: boolean = true
Returns Promise<unknown>
Returns Promise object that represents an Object with the domain's default GIS services
- Defined in gis.ts:59

downloadMobile

downloadMobile(cacheId: any, getGisData?: boolean): Promise<unknown>
Download mobile map cache
Parameters
- cacheId: any
  The mobile map cache Id to download
- getGisData: boolean = true
Returns Promise<unknown>
Returns Promise object that represents a streaming download (?)
- Defined in gis.ts:79

getConfig

getConfig(
    whichType?: any,
    whichId?: any,
    getGisData?: boolean,
    context?: string[],
): Promise<unknown>
Get gis service configuration for user, group, domain, or service id
Parameters
- OptionalwhichType: any
  domain, group, mapservice, or user
- OptionalwhichId: any
  domain, group, mapservice, or user Id
- OptionalgetGisData: boolean = true
  If true, check for feature server JSON data, default is true
- Optionalcontext: string[] = []
  Filter returned list by specific context, i.e. Office, Field, Mobile, Public, etc. Default is all.
Returns Promise<unknown>
Returns Promise object that represents an Object with the desired GIS service definitions
- Defined in gis.ts:26

getEntityAttributes

getEntityAttributes(entityType: string): Promise<unknown>
Get attributes available for provided entity
Parameters
- entityType: string
  The entity type to describe
Returns Promise<unknown>
Returns Promise object that represents a collection of attribute description objects
- Defined in gis.ts:231

initialExtent

initialExtent(): Promise<unknown>
Get initial extent for user

Returns Promise<unknown>
Returns Promise object that represents ... (?)
- Defined in gis.ts:98

inspection

inspection(inspectionId: any, getGisData?: boolean): Promise<unknown>
Get inspection gis services
Parameters
- inspectionId: any
  The WorkOrder to check against.
- getGisData: boolean = true
  If true, check for feature server JSON data, default is true.
Returns Promise<unknown>
Returns Promise object that represents an Object with the specified inspection's entity
- Defined in gis.ts:139

request

request(requestId: any, getGisData?: boolean): Promise<unknown>
Get service request gis services
Parameters
- requestId: any
  The WorkOrder to check against.
- getGisData: boolean = true
  If true, check for feature server JSON data, default is true.
Returns Promise<unknown>
Returns Promise object that represents an Object with the specified request's entit(y|ies)
- Defined in gis.ts:117

selectedEntities

selectedEntities(): Promise<unknown>
Get currently selected entities from the Cityworks install's session for your user

Returns Promise<unknown>
Returns Promise object that represents an Object with the currently-selected entities
- Defined in gis.ts:214

user

user(
    context?: string[],
    allDomains?: boolean,
    allGroups?: boolean,
    getGisData?: boolean,
): Promise<unknown>
Get service request gis services
Parameters
- Optionalcontext: string[] = []
  Filter returned list by specific context, i.e. Office, Field, Mobile, Public, etc. Default is all.
- OptionalallDomains: boolean = true
  services assigned to any domain the user belongs to, default is true
- OptionalallGroups: boolean = true
  services assigned to any groups the user belongs to regardless of domain, default is true
- OptionalgetGisData: boolean = true
  If true, check for feature server JSON data, default is true
Returns Promise<unknown>
Returns Promise object that represents an Object with the user's GIS services
- Defined in gis.ts:185

workOrder

workOrder(workOrderSid: any, getGisData?: boolean): Promise<unknown>
Get workorder gis services
Parameters
- workOrderSid: any
  The WorkOrder to check against.
- getGisData: boolean = true
  If true, check for feature server JSON data, default is true.
Returns Promise<unknown>
Returns Promise object that represents an Object with the specified WorkOrder's entit(y|ies)
- Defined in gis.ts:161