Method	Returns	Description
`encodeForm`	`string`	This is used internally. Formats an object into a html form. In most cases, not necessary to call this.
`request (url, options)`	`promise`	This is used internally. Promisified xhr that does not basic handling of Portal's 400-in-a-200 errors

Items Service

Method	Returns	Description
`search(form)`	`promise`	Executes via `/sharing/rest/search`. The form is an object properties matching the search params
`getById(id)`	`promise`	Returns the Item.
`getDataById(id)`	`promise`	Returns the Item-Data (`/data`).
`update(item)`	`promise`	Updates an existing item. The `.owner` property must be set.
`create(item)`	`promise`	Creates an item. The `.owner` property must be set.
`destroy(itemId, owner)`	`promise`	Delete the item.

Groups Service

Method	Returns	Description
`search(form)`	`promise`	Executes via `/sharing/rest/community/groups`. The form is an object properties matching the search params
`getById(id)`	`promise`	Returns the Group.
`getItemsById(id)`	`promise`	Returns Items in the group. Note: Does not currently support paging.
`save(group)`	`promise`	Creates or Updates a group.
`update(group)`	`promise`	Updates an existing group.
`create(group)`	`promise`	Creates an item. The `.owner` property must be set.
`destroy(id)`	`promise`	Delete the Group.
`users(id)`	`promise`	Return array of users that are members of the Group. Documentation
`addUsers(id, users)`	`promise`	Adds users to the Group. Expects an array of usernames.
`reassign(id, username)`	`promise`	Reassign ownership of the group

Method	Returns	Description
`shareItemWithEveryone(owner, itemId)`	`promise`	Shares an item with everyone
`shareItemWithOrg(owner, itemId)`	`promise`	Shares an item with the Organization
`shareItemsWithGroups(owner, items, groups)`	`promise`	Shares a list of items with a list of groups. Both are arrays of ids. Owner must own all items
`shareItemsWithControl(owner, items, groups)`	`promise`	Similar to `shareItemsWithGroups` except it confirms `itemControl` (aka edit permission conferred via group membership)
`shareItems(options)`	`promise`	Used internally by the other methods, but could be useful in some cases

User Service

Method	Returns	Description
`search(form)`	`promise`	Executes via `/sharing/rest/community/users`. The form is an object properties matching the search params
`getByName(username)`	`promise`	Get a user object by name.

OAuth Service

Note: This is not used for authentication - rather its purpose is to allow Application Items to be programatically manipulated.

Method	Returns	Description
`registerApp (itemId, redirectUris, appType = 'browser')`	`promise`	Registers an App item as an actual AGO Application. Returning clientId, client secret etc
`updateApp(clientId, redirectUris)`	`promise`	Currently just supports changing the set of valid redirect uris. PR's accepted to expand this

environment.js

Configuration for how to connect to the portal is managed in the torii section. If you are using ArcGIS Online, the portalUrl property is not needed.

// environment.js
...
torii: {
  sessionServiceName: 'session',
  providers: {
    'arcgis-oauth-bearer': {
      apiKey: 'SECRET-KEY-FOR-YOUR-APP',
      portalUrl: 'https://yourawesomeportal.com'
    }
  }
}
...

Installation

ember install ember-arcgis-portal-services
npm install
bower install

Running Tests

Note: Currently there are no automated tests for this addon. PR's welcomed :)

npm test (Runs ember try:testall to test your addon against multiple Ember versions)
ember test
ember test --server

[0.8.3]

Added

items-service::uploadResource added optional filename parameter

Keywords

ember-addon

FAQs

What is ember-arcgis-portal-services?

Is ember-arcgis-portal-services popular?

Is ember-arcgis-portal-services well maintained?

Package last updated on 08 Dec 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

ember-arcgis-portal-services