Interface IGroup

Existing Portal Group.

IGroup can also be imported from the following packages:

import { IGroup } from "@esri/arcgis-rest-portal";
interface IGroup {
    access: "private" | "public" | "org";
    autoJoin: boolean;
    created: number;
    description?: string;
    hasCategorySchema?: boolean;
    id: string;
    isFav: boolean;
    isInvitationOnly: boolean;
    isOpenData?: boolean;
    isViewOnly: boolean;
    modified: number;
    owner: string;
    phone?: string;
    protected: boolean;
    snippet?: string;
    sortField?: "title" | "created" | "modified" | "owner" | "avgrating" | "numviews";
    sortOrder?: "asc" | "desc";
    tags: string[];
    thumbnail?: string;
    title: string;
    userMembership?: {
        applications?: number;
        memberType?: GroupMembership;
        username?: string;
    };
}

Hierarchy (view full)

Properties

access autoJoin created description? hasCategorySchema? id isFav isInvitationOnly isOpenData? isViewOnly modified owner phone? protected snippet? sortField? sortOrder? tags thumbnail? title userMembership?

Properties

access

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

autoJoin

autoJoin: boolean

created

created: number

Optional description

description?: string

Optional hasCategorySchema

hasCategorySchema?: boolean

id

id: string

isFav

isFav: boolean

isInvitationOnly

isInvitationOnly: boolean

Optional isOpenData

isOpenData?: boolean

isViewOnly

isViewOnly: boolean

modified

modified: number

owner

owner: string

Optional phone

phone?: string

protected

protected: boolean

Optional snippet

snippet?: string

Optional sortField

sortField?: "title" | "created" | "modified" | "owner" | "avgrating" | "numviews"

Optional sortOrder

sortOrder?: "asc" | "desc"

tags

tags: string[]

Optional thumbnail

thumbnail?: string

title

title: string

Optional userMembership

userMembership?: {
    applications?: number;
    memberType?: GroupMembership;
    username?: string;
}

Type declaration

  • Optional applications?: number
  • Optional memberType?: GroupMembership
  • Optional username?: string

Settings

Member Visibility

Theme

On This Page

accessautoJoincreateddescriptionhasCategorySchemaidisFavisInvitationOnlyisOpenDataisViewOnlymodifiedownerphoneprotectedsnippetsortFieldsortOrdertagsthumbnailtitleuserMembership