ArcGISKit Documentation

Structures

Comma​Separated​Capability​Coder
Content​Item

An item (a unit of content) in the portal. Each item has a unique identifier and a well known URL that is independent of the user owning the item.

Feature​Layer
Feature​Layer​Info
Drawing​Info
Drawing​Info.​Renderer
Drawing​Info.​Renderer.​Unique​Value​Info
Drawing​Info.​Renderer.​Unique​Value​Info.​Symbol
Drawing​Info.​Renderer.​Unique​Value​Info.​Symbol.​Outline
Drawing​Info.​Renderer.​Authoring​Info
Drawing​Info.​Renderer.​Authoring​Info.​Color​Ramp
Drawing​Info.​Renderer.​Authoring​Info.​Color​Ramp.​Color​Ramp
Layer​Query
Edit​Response
Edit​Result
Feature​Service

A feature service can contain datasets (for example, tables and views) with or without a spatial column. Datasets with a spatial column are considered layers; those without a spatial column are considered tables. A feature service allows clients to query and edit feature geometry and attributes.

Advanced​Editing​Capabilities
Spatial​Reference
Layer
Table
Relationship
Controller​Dataset​Layer
Height​Model​Info
Datum​Transformation
Geo​Transform
Extent
Validation​System​Layer
Extract​Changes​Capability
Sync​Capability
Editor​Tracking​Info
Query​Response
Geometry​Properties
Coded​Value
Table​Domain
Table​Field
AGKAttachment
AGKGeometry
Paginated
Folder
Attachment​Group
Exif​Info
Exif​Info​Tags
Membership

Enumerations

Authentication​Type

The methods to use to authenticate.

Access
Item​Control
Content​Type

The type of content owned by you or a Group you are in.

Either
AGKError
AGKAuth​Error
AGKData​Error
AGKRequest​Error

Errors encountered when making API requests.

ESRIField​Type

Field Types.

SQLFormat
Capability
Table​Domain.​Domain​Type
Sort​Order

The order results are sorted by.

Provider

Indicates the level of access of the user: private, org, public, or account. If private, the user descriptive information will not be available to others nor will the username be searchable.

Role

Functions

fetch​Attachments(gis:​)

Fetch all the Attachments contained in this Feature.

add​Attachment(data:​name:​gis:​mime​Type:​)

Add an Attachment to this Feature.

delete​Attachments(ids:​gis:​)

Deletes all the Attachments whose ID is contained within ids.

append()
info(layer​ID:​)
query(layer​Queries:​return​Geometry:​return​Object​IDs:​return​Count:​return​Z:​return​M:​geometry​Precision:​return​True​Curves:​sql​Format:​gdb​Version:​)

Query the FeatureServer.

delete(_:​from:​gdb​Version:​)

Deletes features from the FeatureLayer with the id of id.

add(_:​to:​gdb​Version:​)

Adds features to the FeatureLayer with the id of id.

update(_:​in:​gdb​Version:​)

Updates features in the FeatureLayer with the id of id.

fetch​Token()

Requests a token and saves it in self.currentToken.

generate​URL(client​ID:​base​URL:​site:​redirect​URI:​)

Generates a URL that users of your app should go to to authenticate. Once they authenticate, they should copy and paste the authentication code back into your app; that code can then be passed to GIS.init.

advance(limit:​)

Retrieves the values from self.nextStart to limit.

fetch​Content(from:​)

Retrieves the content owned by this Group.

fetch​Content(from:​)

Retrieves the content owned by this User.

update(clear​Empty​Fields:​gis:​)

Updates the information for this User on ArcGIS Online or Enterprise.

move​Item(to:​)
create​Folder(name:​gis:​)

Creates a folder in which items can be placed. Folders are only visible to a user and solely used for organizing content within that user's content space.

add​File(name:​data:​folder:​type:​tags:​gis:​)

Variables

geometry
attributes
attachments

The Attachments contained in this Feature.

url
url

The URL used to access the User's ArcGIS Online organization, ArcGIS Enterprise installation, et cetera.

username

The username of the current User, if logged in.

password

The password of the current User, if logged in.

auth​Type
is​Anonymous
current​Token

The token for the logged in User.

refresh​Token

The token that is used to refresh self.currentToken.

token​Expiration​Date

The Date when self.currentToken will expire.

token​Expired

If self.currentToken expired.

current
id

The given group ID.

title

The title of the group. This is the name that is displayed to users and by which they refer to the group. Every group must have a title, and it must be unique for a user.

is​Invitation​Only

If this is set to true, users will not be able to apply to join the group.

owner

The owner user name of the group.

description

The group description.

type​Keywords

An array of keywords that further describes a group.

snippet

The group summary.

tags

User-defined tags that describe the group.

phone

The contact information for the group.

sort​Field

The sorted field.

sort​Order

The sort order, either descending or ascending.

is​View​Only

Boolean value indicating whether the results are only for viewing.

is​Fav

Boolean value indicating whether marked in favorites.

thumbnail

The URL to the thumbnail used for the group. All group thumbnails are relative to the URL: https://[<community-url>](https://developers.arcgis.com/rest/users-groups-and-items/community-root.htm)/groups/<groupId>/info.

created

THe date the group was created.

modified

The date the group was last modified.

access

The access privileges of the group that determine who can see and access the group. This can be set to private, org, or public.

user​Membership

If the request is made by an authenticated user, a UserMembership object is returned containing information about the user's access to the group. This includes the username of the calling user; the memberType, which specifies the type of membership the user has in the group (owner, member, admin, none); and the applications (number of requests to join the group) count available to administrators and owners.

protected

Indicates if the group is protected from deletion. The default value is false.

auto​Join

Only applies to org accounts. Indicates if the group allows joining without requesting membership approval. The default value is false.

has​Category​Schema

If true, the group has content category set.

is​Open​Data

If true, the group is designated as available for use in Open Data sites.

id

The ID of the user.

first​Name

The user's first name.

last​Name

The user's last name.

full​Name

The user's full name.

username

The username of the given user.

idp​Username

The original username if using enterprise logins.

email

The user's e-mail address.

description

A description of the user.

tags

User-defined tags that describe the user.

available​Credits

The number of credits available to the user.

assigned​Credits

The number of credits allocated to the user.

preferred​View

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

access

Indicates the level of access of the user: private, org, or public. If private, the user descriptive information will not be available to others nor will the username be searchable.

mfa​Enabled

Indicates if the user's account has multifactor authentication set up.

fav​Group​Id

The user's favorites group and is created automatically for each user.

last​Login

The last login date of the user.

storage​Usage

The total storage used by the user's organization or subscription in Byte.

storage​Quota

The total storage amount allowed for the user's organization or subscription in Byte. Usually 2TB for organization, 2GB for non-organization.

org​Id

The ID of the organization the user belongs to.

role

Defines the user's role in the organization.

privileges

An array of Privileges for this User. For a complete listing, see Privileges.

role​Id

(Optional) The ID of the user's role if it is a custom one.

user​License​Type​Id

The user's user license type ID.

disabled

Disables access to the organization by the user.

units

User-defined units for measurement.

culture

The user locale information (language and country).

culture​Format

The user preferred number and date format defined in CLDR (only applicable for English and Spanish, i.e. when culture is en or es). See Languages for supported formats. It will inherit from organization cultureFormat if undefined.

region

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.

thumbnail

The file name of the thumbnail used for the user.

created

The date the user was created.

modified

The date the user was last modified.

groups

An array of groups the user belongs to. See Group for properties of a group.

provider

The identity provider for the organization.