Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PortalUser

Hierarchy

Index

Properties

access

access: "public" | "private" | "org"

Indicates the level of access of the user.

Read more...

created

created: Date

The date the user was created.

Read more...

culture

culture: string

The culture information for the user.

Read more...

declaredClass

declaredClass: string

description

description: string

A description of the user.

Read more...

destroyed

destroyed: boolean

email

email: string

The user's e-mail address.

Read more...

fullName

fullName: string

The user's full name.

Read more...

initialized

initialized: boolean

modified

modified: Date

The date the user was last modified.

Read more...

orgId

orgId: string

The ID of the organization the user belongs to.

Read more...

portal

portal: Portal

The portal associated with the user.

Read more...

preferredView

preferredView: string

The user's preferred view for content, either web or GIS.

Read more...

region

region: string

The user preferred region, used to set the featured maps on the home page, content in the gallery, and the default extent of new maps in the Viewer.

Read more...

role

role: "org_admin" | "org_publisher" | "org_user"

Defines the user's role in the organization.

Read more...

roleId

roleId: string

The ID of the user's role.

Read more...

sourceJSON

sourceJSON: any

The JSON used to create the property values when the PortalUser is created.

Read more...

Readonly thumbnailUrl

thumbnailUrl: string

The URL to the thumbnail image for the user.

Read more...

units

units: "metric" | "english"

The user's personal units of measure setting.

Read more...

Readonly userContentUrl

userContentUrl: string

The URL for the user's content.

Read more...

username

username: string

The username of the user.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): PortalUser
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns PortalUser

addItem

deleteItem

  • Deletes an item from the user's portal content.

    Read more...

    Parameters

    Returns Promise<any>

deleteItems

  • Deletes items from the user's portal content.

    Read more...

    Parameters

    Returns Promise<any>

destroy

  • destroy(): void
  • Returns void

fetchFolders

  • Fetches all of the user's folders used to organize portal content.

    Read more...

    Returns Promise<PortalFolder[]>

fetchGroups

  • Fetches all the groups that the portal user has permission to access.

    Read more...

    Returns Promise<PortalGroup[]>

fetchItems

  • Retrieves all the items in the specified folder.

    Read more...

    Parameters

    Returns Promise<any>

fetchTags

  • fetchTags(): Promise<any[]>
  • Fetches the tag objects that have been created by the portal user.

    Read more...

    Returns Promise<any[]>

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getThumbnailUrl

  • getThumbnailUrl(width?: number): string
  • Get the URL to the thumbnail image for the user.

    Read more...

    Parameters

    • Optional width: number

    Returns string

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

queryFavorites

  • Executes a query against the user's favorite group to return an array of PortalItem objects that match the input query.

    Read more...

    Parameters

    Returns Promise<PortalQueryResult>

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns PortalUser

  • Parameters

    Returns PortalUser

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc