Class AtlasOrganization

viewer

attr

• get attr(): undefined | AttributesType

• returns the object's information; this may be undefined

  Returns undefined | AttributesType

apiCall

• apiCall(endpoint, method, payload?, headers?): Promise<null | string | any[] | Record<string, any> | Uint8Array | Table<any>>

• Parameters

  • endpoint: string
  • method: "GET" | "POST"
  • payload: Payload = null
  • headers: null | Record<string, string> = null

  Returns Promise<null | string | any[] | Record<string, any> | Uint8Array | Table<any>>

fetchAttributes

• fetchAttributes(bustCache?): Promise<OrganizationInfo>

• Fetches basic information about the object. By default, this caches the call; if you want to bust the cache, pass true as the first argument. This immediately.

  Parameters

  • bustCache: boolean = false

    Whether to refetch the relevant information

  Returns Promise<OrganizationInfo>

  A promise that resolves to the organization info.

withLoadedAttributes

• withLoadedAttributes(): Promise<LoadedObject<AtlasOrganization, OrganizationInfo>>

• Loads the information associated with the class, removing any existing caches.

  Returns Promise<LoadedObject<AtlasOrganization, OrganizationInfo>>

  a LoadedObject instance of the class that is guaranteed to have its attr slot populated with appropriate information.

  Example

  const loadedProject = await (new AtlasProject(projectId)).withLoadedAttributes()
  
   // OR, in cases where we want to do stuff immediately with the project and ensure
   // that later calls there don't double-fetch information.
  
   const project = new AtlasProject(projectId)
  
   // do stuff right away.
   const projection = new AtlasProjection(projectionId, {project: project})
   const loadedProjection = await projection.withLoadedAttributes()
   // do stuff with loadedProjection
  Copy