blob: 48bd3fc7c52a45b28015a03f4c2a304289f2997c [file] [log] [blame]
# Usergrid SDK Documentation outline
## Getting Started
### Installing the SDK
### Building from Source
# Usergrid SDK Reference with Examples
The 66 topics listed below are each documented in the Usergrid documentation and
for each the docs provide an API reference and example for each of these clients:
curl, iOS, Android, JavaScript, Ruby and Node.js.
## Working with Collections
### 1. Creating collections
### 2. Retrieving collections
### 3. Updating collections
### 4. Deleting collections
## Working with Entities
### 5. Creating a custom entity
### 6. Creating multiple custom entities
### 7. Creating an entity with sub-properties
### 8. Retrieving an entity
### 9. Retrieving multiple entities
### 10. Updating an entity
### 11. Updating a sub-property
### 12. Deleting data entities
## Data Queries
### 13. Querying your data
## Entity Connections
### 14. Connecting users other data
### 15. Retrieving user connection data
### 16. Disconnecting entities
## Permissions & Roles
### 17. Assigning permissions
### 18. Removing permissions
### 19. Assigning permissions
### 20. Removing permissions
### 21. Creating roles
### 22. Assigning roles
### 23. Removing roles
## Authentication
### 24. Application user authentication (user login)
### 25. Application client authentication
### 26. Admin user authentication
### 27. Organization client authentication
### 28. Revoking tokens (user logout)
# Working with Users & Groups
### 29. Creating users
### 30. Retrieving user data
### 31. Setting or updating password
### 32. Creating groups
### 33. Retrieving group data
### 34. Retrieving a group's users
### 35. Adding users groups
### 36. Deleting user group
## Activities & Feeds
### 37. Posting a user activity
### 38. Posting an activity to a group
### 39. Creating an activity for a user's followers in a group
### 40. Retrieving a user's activity feed
### 41. Retrieving a group's activity feed
## Events & Counters
### 42. Creating & incrementing counters
### 43. Retrieving counters
### 44. Retrieving counters by time interval
## Managing Orgs & Apps
### 46. Creating an organization
### 47. Getting an organization
### 48. Activating an organization
### 49. Reactivating an organization
### 50. Generating organization client credentials
### 51. Retrieving organization client credentials
### 52. Getting an organization's activity feed
### 53. Getting the applications in an organization
### 54. Getting the admin users in an organization
### 55. Removing an admin user from an organization
### 56. Creating an organization application
### 57. Generating application credentials
### 58. Getting application credentials
## Managing Admin Users
### 59. Creating an admin user
### 60. Updating an admin user
### 61. Getting an admin user
### 62. Setting an admin user's password
### 63. Resetting an admin user's password
### 64. Activating an admin user
### 65. Reactivating an admin user
### 66. Getting an admin user's activity feed