Index
A B C D E F G H I L M N O P R S T U V W X
All Classes|All Packages
All Classes|All Packages
All Classes|All Packages
A
- acceptOwnership(String) - Method in class com.contentstack.cms.stack.Stack
-
Accept Stack Ownership
The Accept stack owned by other user call allows a user to accept the ownership of a particular stack via an email invitation. - acceptOwnership(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.StackService
- activateAccount(String, JSONObject) - Method in class com.contentstack.cms.user.User
-
The activate_token a user account call activates the account of a user after signing up.
- activateAccount(String, JSONObject) - Method in interface com.contentstack.cms.user.UserService
- active - Variable in class com.contentstack.cms.models.UserModel
- add(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.EnvironmentService
- add(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.LabelService
- addBranch(String) - Method in class com.contentstack.cms.stack.Label
-
Enter your branch unique ID
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.Alias
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.Asset
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.AuditLog
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.Branch
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.ContentType
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.DeliveryToken
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.Entry
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.Environment
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.Extensions
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.Folder
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.GlobalField
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.Label
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.Locale
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.ManagementToken
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.PublishQueue
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.Release
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.ReleaseItem
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.Roles
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.Stack
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.Webhook
-
Sets header for the request
- addHeader(String, Object) - Method in class com.contentstack.cms.stack.Workflow
-
Sets header for the request
- addHeader(String, String) - Method in class com.contentstack.cms.organization.Organization
-
Sets header for the request
- addItem(Map<String, Object>, String, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.ReleaseService
- addItems(Map<String, Object>, String, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.ReleaseService
- addParam(String, Object) - Method in class com.contentstack.cms.organization.Organization
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.Alias
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.Asset
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.AuditLog
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.Branch
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.ContentType
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.DeliveryToken
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.Entry
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.Environment
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.Extensions
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.Folder
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.GlobalField
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.Label
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.Locale
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.ManagementToken
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.PublishQueue
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.Release
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.ReleaseItem
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.Roles
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.Stack
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.Webhook
-
Sets header for the request
- addParam(String, Object) - Method in class com.contentstack.cms.stack.Workflow
-
Sets header for the request
- alias() - Method in class com.contentstack.cms.stack.Stack
-
An alias acts as a pointer to a particular branch.
- alias(String) - Method in class com.contentstack.cms.stack.Stack
-
An alias acts as a pointer to a particular branch.
- Alias - Class in com.contentstack.cms.stack
-
An alias acts as a pointer to a particular branch.
- Alias(Retrofit) - Constructor for class com.contentstack.cms.stack.Alias
- Alias(Retrofit, String) - Constructor for class com.contentstack.cms.stack.Alias
- AliasService - Interface in com.contentstack.cms.stack
- allInvitations() - Method in class com.contentstack.cms.organization.Organization
-
Get all organization invitations
The Get all organization invitations call gives you a list of all the Organization invitations. - allUsers() - Method in class com.contentstack.cms.stack.Stack
-
Get all users of a stack
- allUsers(Map<String, Object>) - Method in interface com.contentstack.cms.stack.StackService
- API_KEY - Static variable in class com.contentstack.cms.core.Util
- asJson() - Method in class com.contentstack.cms.core.CMAResponseConvertor
- asJson(String) - Method in class com.contentstack.cms.core.CMAResponseConvertor
- assertionError() - Static method in class com.contentstack.cms.core.Util
-
When private constructor to be initialized
AssertionError
otherwise. - asset() - Method in class com.contentstack.cms.stack.Stack
-
Assets
Assets refer to all the media files (images, videos, PDFs, audio files, and so on) uploaded in your Contentstack repository for future use. - asset(String) - Method in class com.contentstack.cms.stack.Stack
-
Assets
Assets refer to all the media files (images, videos, PDFs, audio files, and so on) uploaded in your Contentstack repository for future use. - Asset - Class in com.contentstack.cms.stack
-
Assets refer to all the media files (images, videos, PDFs, audio files, and so on) uploaded in your Contentstack repository for future use.
- Asset(Retrofit, Map<String, Object>) - Constructor for class com.contentstack.cms.stack.Asset
- Asset(Retrofit, Map<String, Object>, String) - Constructor for class com.contentstack.cms.stack.Asset
- AssetService - Interface in com.contentstack.cms.stack
- asString() - Method in class com.contentstack.cms.core.CMAResponseConvertor
- atomicOperation(JSONObject) - Method in class com.contentstack.cms.stack.Entry
-
Atomic operations are particularly useful when we do not want content collaborators to overwrite data.
- atomicOperations(Map<String, Object>, String, String, JSONObject) - Method in interface com.contentstack.cms.stack.EntryService
- auditLog() - Method in class com.contentstack.cms.stack.Stack
-
Audit log displays a record of all the activities performed in a stack and helps you keep a track of all published items, updates, deletes, and current status of the existing content.
- auditLog(String) - Method in class com.contentstack.cms.stack.Stack
-
Audit log displays a record of all the activities performed in a stack and helps you keep a track of all published items, updates, deletes, and current status of the existing content.
- AuditLog - Class in com.contentstack.cms.stack
-
Audit log displays a record of all the activities performed in a stack and helps you keep a track of all published items, updates, deletes, and current status of the existing content.
- AuditLog(Retrofit) - Constructor for class com.contentstack.cms.stack.AuditLog
- AuditLog(Retrofit, String) - Constructor for class com.contentstack.cms.stack.AuditLog
- AuditLogService - Interface in com.contentstack.cms.stack
- AuthInterceptor - Class in com.contentstack.cms.core
-
The type Header interceptor that extends Interceptor
- AuthInterceptor() - Constructor for class com.contentstack.cms.core.AuthInterceptor
- AuthInterceptor(String) - Constructor for class com.contentstack.cms.core.AuthInterceptor
- AUTHORIZATION - Static variable in class com.contentstack.cms.core.Util
- authtoken - Variable in class com.contentstack.cms.Contentstack
- authtoken - Variable in class com.contentstack.cms.core.AuthInterceptor
- authtoken - Variable in class com.contentstack.cms.models.UserModel
- AUTHTOKEN - Static variable in class com.contentstack.cms.core.Util
B
- branch() - Method in class com.contentstack.cms.stack.Stack
-
Branches
Branches allows you to isolate and easily manage your in-progress work from your stable, live work in the production environment. - branch(String) - Method in class com.contentstack.cms.stack.Stack
-
Branches
Branches allows you to isolate and easily manage your in-progress work from your stable, live work in the production environment. - Branch - Class in com.contentstack.cms.stack
-
Branches allows you to isolate and easily manage your “in-progress” work from your stable, live work in the production environment.
- Branch(Retrofit) - Constructor for class com.contentstack.cms.stack.Branch
- Branch(Retrofit, String) - Constructor for class com.contentstack.cms.stack.Branch
- BRANCH - Static variable in class com.contentstack.cms.core.Util
- BranchService - Interface in com.contentstack.cms.stack
- build() - Method in class com.contentstack.cms.Contentstack.Builder
-
Build contentstack.
- Builder() - Constructor for class com.contentstack.cms.Contentstack.Builder
-
Instantiates a new Builder.
- byFolderUid(String) - Method in class com.contentstack.cms.stack.Asset
-
The Get assets of a specific folder retrieves all assets of a specific asset folder; however, it doesn't retrieve the details of sub-folders within it.
C
- cancelScheduledAction() - Method in class com.contentstack.cms.stack.PublishQueue
-
The Cancel Scheduled Action request will allow you to cancel any scheduled publishing or unpublishing activity of entries and/or assets and also cancel the deployment of releases
- cancelScheduledAction(Map<String, Object>, String, HashMap<String, Object>) - Method in interface com.contentstack.cms.stack.PublishQueueService
- clearParams() - Method in class com.contentstack.cms.organization.Organization
-
Clear all params
- clearParams() - Method in class com.contentstack.cms.stack.Alias
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.Asset
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.AuditLog
-
To clear all the params
- clearParams() - Method in class com.contentstack.cms.stack.Branch
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.ContentType
-
To clear all the query parameters of request
- clearParams() - Method in class com.contentstack.cms.stack.DeliveryToken
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.Entry
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.Environment
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.Extensions
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.Folder
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.GlobalField
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.Label
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.Locale
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.ManagementToken
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.PublishQueue
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.Release
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.ReleaseItem
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.Roles
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.Stack
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.Webhook
-
To clear all the query params
- clearParams() - Method in class com.contentstack.cms.stack.Workflow
-
To clear all the query params
- client - Variable in class com.contentstack.cms.stack.Stack
- clone(JSONObject) - Method in class com.contentstack.cms.stack.Release
-
The Clone a Release request allows you to clone (make a copy of) a specific Release in a stack.
- clone(Map<String, Object>, String, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.ReleaseService
- CMALogger - Class in com.contentstack.cms.core
-
The Contentstack Logger
- CMALogger(Class<?>) - Constructor for class com.contentstack.cms.core.CMALogger
- CMAResponseConvertor - Class in com.contentstack.cms.core
-
Contentstack Response:
- CMAResponseConvertor(Response<ResponseBody>) - Constructor for class com.contentstack.cms.core.CMAResponseConvertor
- CMARuntimeException - Exception in com.contentstack.cms.core
-
CMARuntimeException that extends Exception class
- CMARuntimeException(String) - Constructor for exception com.contentstack.cms.core.CMARuntimeException
- code - Variable in class com.contentstack.cms.stack.Locale
- com.contentstack.cms - package com.contentstack.cms
-
This is topmost package that is used to contains all the sub-packages in itself like core, models, organisations, stacks, users and contentstack
- com.contentstack.cms.core - package com.contentstack.cms.core
-
Useful to access contentstack's core components
- com.contentstack.cms.models - package com.contentstack.cms.models
-
Useful to access contentstack's models and pojo classes
- com.contentstack.cms.organization - package com.contentstack.cms.organization
-
Useful to access contentstack's organizations
- com.contentstack.cms.stack - package com.contentstack.cms.stack
-
Useful to access contentstack's stack informations.
- com.contentstack.cms.user - package com.contentstack.cms.user
-
Useful to access contentstack's user information
- company - Variable in class com.contentstack.cms.models.UserModel
- CONTENT_TYPE - Static variable in class com.contentstack.cms.core.Util
- CONTENT_TYPE_VALUE - Static variable in class com.contentstack.cms.core.Util
- Contentstack - Class in com.contentstack.cms
-
Contentstack Java Management SDK
Java Management SDK Interact with the Content Management APIs and allow you to create, update, delete, and fetch content from your Contentstack account. - Contentstack(Contentstack.Builder) - Constructor for class com.contentstack.cms.Contentstack
-
Instantiates a new Contentstack.
- Contentstack.Builder - Class in com.contentstack.cms
-
The type Builder.
- contentType() - Method in class com.contentstack.cms.stack.Stack
-
Content type
- contentType(String) - Method in class com.contentstack.cms.stack.Stack
-
Content type
- ContentType - Class in com.contentstack.cms.stack
-
Content type defines the structure or schema of a page or a section of your web or mobile property.
- ContentType(Retrofit, Map<String, Object>) - Constructor for class com.contentstack.cms.stack.ContentType
-
Instantiates a new Content type.
- ContentType(Retrofit, Map<String, Object>, String) - Constructor for class com.contentstack.cms.stack.ContentType
-
Instantiates a new Content type.
- ContentTypeService - Interface in com.contentstack.cms.stack
- contentTypeUid - Variable in class com.contentstack.cms.stack.ContentType
- contentTypeUid - Variable in class com.contentstack.cms.stack.Entry
- create(String, JSONObject) - Method in class com.contentstack.cms.stack.Stack
-
Create stack.
The Create stack call creates a new stack in your Contentstack account. - create(JSONObject) - Method in class com.contentstack.cms.stack.Branch
-
The Create a branch request creates a new branch in a particular stack of your organization.
- create(JSONObject) - Method in class com.contentstack.cms.stack.DeliveryToken
-
The Create delivery token request is used to create a delivery token in the stack.
- create(JSONObject) - Method in class com.contentstack.cms.stack.Environment
-
The Add an environment call will add a publishing environment for a stack.
- create(JSONObject) - Method in class com.contentstack.cms.stack.GlobalField
-
Create Global Field
- create(JSONObject) - Method in class com.contentstack.cms.stack.Label
-
This call is used to create a label.
- create(JSONObject) - Method in class com.contentstack.cms.stack.Locale
-
Add a language
This call lets you add a new language to your stack. - create(JSONObject) - Method in class com.contentstack.cms.stack.ManagementToken
-
The Create management token request is used to create a management token in a stack.
- create(JSONObject) - Method in class com.contentstack.cms.stack.Release
-
To Create a Release request allows you to create a new Release in your stack.
- create(JSONObject) - Method in class com.contentstack.cms.stack.ReleaseItem
-
Add a single item to a Release request allows you to add an item (entry or asset) to a Release.
- create(JSONObject) - Method in class com.contentstack.cms.stack.Roles
-
The Create a role request creates a new role in a stack.
- create(JSONObject) - Method in class com.contentstack.cms.stack.Webhook
-
The Create a webhook request allows you to create a new webhook in a specific stack.
- create(JSONObject) - Method in class com.contentstack.cms.stack.Workflow
-
The Create a Workflow request allows you to create a Workflow.
- create(JSONObject) - Method in class com.contentstack.cms.stack.Folder
-
The Create a folder call is used to create an asset folder and/or add a parent folder to it (if required).
- create(String, JSONObject) - Method in interface com.contentstack.cms.stack.StackService
- create(Map<String, Object>, String, JSONObject, Map<String, Object>) - Method in interface com.contentstack.cms.stack.EntryService
- create(Map<String, Object>, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.ContentTypeService
- create(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.BranchService
- create(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.GlobalFieldService
- create(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.LocaleService
- create(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.ReleaseService
- create(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.WebhookService
- create(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.WorkflowService
- create(JSONObject) - Method in class com.contentstack.cms.stack.ContentType
-
Create Content Type
- create(JSONObject) - Method in class com.contentstack.cms.stack.Entry
-
The Create an entry call creates a new entry for the selected content type.
- createContentTypeWithExtensionField(Map<String, Object>, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.ExtensionsService
- createdAt - Variable in class com.contentstack.cms.models.UserModel
- createDeliveryToken(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.TokenService
- createFolder(Map<String, Object>, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.AssetService
- createManagementToken(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.TokenService
- createMultiple(JSONObject) - Method in class com.contentstack.cms.stack.ReleaseItem
-
Add multiple items to a Release request allows you to add multiple items (entries and/or assets) to a Release.
- createPublishRule(JSONObject) - Method in class com.contentstack.cms.stack.Workflow
-
The Create Publish Rules request allows you to create publish rules for the workflow of a stack.
- createPublishRules(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.WorkflowService
- createRole(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.RolesService
- customFieldUid - Variable in class com.contentstack.cms.stack.Extensions
D
- defaultUserAgent() - Static method in class com.contentstack.cms.core.Util
-
Default user agent string.
- delete() - Method in class com.contentstack.cms.stack.Alias
-
Delete an alias request deletes an existing alias.
- delete() - Method in class com.contentstack.cms.stack.Asset
-
Delete asset call will delete an existing asset from the stack.
- delete() - Method in class com.contentstack.cms.stack.Branch
-
The Get assets and folders of a parent folder retrieves details of both assets and asset subfolders within a specific parent asset folder.
- delete() - Method in class com.contentstack.cms.stack.ContentType
-
Delete Content Type.
- delete() - Method in class com.contentstack.cms.stack.DeliveryToken
-
The Delete delivery token request deletes a specific delivery token
- delete() - Method in class com.contentstack.cms.stack.Entry
-
To Delete an entry request allows you to delete a specific entry from a content type.
- delete() - Method in class com.contentstack.cms.stack.Environment
-
Delete environment call will delete an existing publishing environment from your stack.
- delete() - Method in class com.contentstack.cms.stack.Extensions
-
Delete custom field request is used to delete a specific custom field
- delete() - Method in class com.contentstack.cms.stack.Folder
-
Delete a folder call is used to delete an asset folder along with all the assets within that folder.
- delete() - Method in class com.contentstack.cms.stack.GlobalField
-
Delete global field
- delete() - Method in class com.contentstack.cms.stack.Label
-
Delete label call is used to delete a specific label.
- delete() - Method in class com.contentstack.cms.stack.Locale
-
Delete language call deletes an existing language from your stack.
- delete() - Method in class com.contentstack.cms.stack.ManagementToken
-
The Delete management token request deletes a specific management token
- delete() - Method in class com.contentstack.cms.stack.Release
-
To Delete a Release request allows you to delete a specific Release from a stack.
- delete() - Method in class com.contentstack.cms.stack.ReleaseItem
-
The Remove an item from a Release request removes one or more items (entries and/or assets) from a specific Release.
- delete() - Method in class com.contentstack.cms.stack.Roles
-
The Delete role call deletes an existing role from your stack.
- delete() - Method in class com.contentstack.cms.stack.Webhook
-
To Delete webhook call deletes an existing webhook from a stack.
- delete() - Method in class com.contentstack.cms.stack.Workflow
-
Delete Workflow request allows you to delete a workflow.
- delete(Boolean) - Method in class com.contentstack.cms.stack.DeliveryToken
-
The Delete delivery token request deletes a specific delivery token.
- delete(String, Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.ContentTypeService
- delete(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.AssetService
- delete(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.EnvironmentService
- delete(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.ExtensionsService
- delete(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.GlobalFieldService
- delete(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.LabelService
- delete(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.LocaleService
- delete(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.ReleaseService
- delete(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.WebhookService
- delete(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.WorkflowService
- delete(Map<String, Object>, String, String, JSONObject, Map<String, Object>) - Method in interface com.contentstack.cms.stack.EntryService
- delete(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.AliasService
- delete(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.BranchService
- delete(JSONObject) - Method in class com.contentstack.cms.stack.Entry
-
To Delete an entry request allows you to delete a specific entry from a content type.
- deleteDeliveryToken(Map<String, Object>, String, Boolean) - Method in interface com.contentstack.cms.stack.TokenService
- deleteFolder(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.AssetService
- deleteManagementToken(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.TokenService
- deletePublishRule(String) - Method in class com.contentstack.cms.stack.Workflow
-
To Delete Publish Rules request allows you to delete an existing publish rule.
- deletePublishRules(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.WorkflowService
- deleteRole(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.RolesService
- deleteVersionName(int) - Method in class com.contentstack.cms.stack.Asset
-
Delete Version Name of Asset
- deleteVersionName(int, JSONObject) - Method in class com.contentstack.cms.stack.Entry
- deleteVersionName(Map<String, Object>, String, int) - Method in interface com.contentstack.cms.stack.AssetService
- deleteVersionName(Map<String, Object>, String, String, int, JSONObject) - Method in interface com.contentstack.cms.stack.EntryService
- DeliveryToken - Class in com.contentstack.cms.stack
-
Delivery tokens:Delivery tokens provide read-only access to the associated environments, while management tokens provide read-write access to the content of your stack.
- DeliveryToken(TokenService) - Constructor for class com.contentstack.cms.stack.DeliveryToken
- DeliveryToken(TokenService, String) - Constructor for class com.contentstack.cms.stack.DeliveryToken
- deliveryTokens() - Method in class com.contentstack.cms.stack.Tokens
-
You can use Delivery Tokens to authenticate Content Delivery API (CDA) requests and retrieve the published content of an environment.
- deliveryTokens(String) - Method in class com.contentstack.cms.stack.Tokens
-
You can use Delivery Tokens to authenticate Content Delivery API (CDA) requests and retrieve the published content of an environment.
- deploy(JSONObject) - Method in class com.contentstack.cms.stack.Release
-
The Deploy a Release request deploys a specific Release to specific environment(s) and locale(s).
- deploy(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.ReleaseService
- detailOfAllVersion() - Method in class com.contentstack.cms.stack.Entry
-
The Get Details of All Versions of an Entry request allows you to retrieve the details of all the versions of an entry.
- detailOfAllVersion(Map<String, Object>, String, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.EntryService
- disable() - Method in class com.contentstack.cms.stack.Workflow
-
Disable Workflow request allows you to disable a workflow.
- disable(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.WorkflowService
- downloadPermanentUrl(Map<String, Object>, String, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.AssetService
E
- email - Variable in class com.contentstack.cms.models.UserModel
- enable() - Method in class com.contentstack.cms.stack.Workflow
-
Enable Workflow request allows you to enable a workflow.
- enable(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.WorkflowService
- entry() - Method in class com.contentstack.cms.stack.ContentType
-
An entry is the actual piece of content created using one of the defined
- entry(String) - Method in class com.contentstack.cms.stack.ContentType
-
An entry is the actual piece of content created using one of the defined
- Entry - Class in com.contentstack.cms.stack
-
An entry is the actual piece of content created using one of the defined content types.
- Entry(Retrofit, Map<String, Object>, String) - Constructor for class com.contentstack.cms.stack.Entry
- Entry(Retrofit, Map<String, Object>, String, String) - Constructor for class com.contentstack.cms.stack.Entry
- EntryService - Interface in com.contentstack.cms.stack
- entryUid - Variable in class com.contentstack.cms.stack.Entry
- environment - Variable in class com.contentstack.cms.stack.Environment
- environment() - Method in class com.contentstack.cms.stack.Stack
-
A publishing environment corresponds to one or more deployment servers or a content delivery destination where the entries need to be published.
- environment(String) - Method in class com.contentstack.cms.stack.Stack
-
A publishing environment corresponds to one or more deployment servers or a content delivery destination where the entries need to be published.
- Environment - Class in com.contentstack.cms.stack
-
A publishing environment corresponds to one or more deployment servers or a content delivery destination where the entries need to be published.
- Environment(Retrofit) - Constructor for class com.contentstack.cms.stack.Environment
- Environment(Retrofit, String) - Constructor for class com.contentstack.cms.stack.Environment
- EnvironmentService - Interface in com.contentstack.cms.stack
- Error - Class in com.contentstack.cms.models
- Error() - Constructor for class com.contentstack.cms.models.Error
- errorCode - Variable in class com.contentstack.cms.models.Error
- errorMessage - Variable in class com.contentstack.cms.models.Error
- errors - Variable in class com.contentstack.cms.models.Error
- export() - Method in class com.contentstack.cms.stack.ContentType
-
Export Content Type.
- export() - Method in class com.contentstack.cms.stack.Entry
-
The Export an entry call is used to export an entry.
- export() - Method in class com.contentstack.cms.stack.GlobalField
-
Export global field
- export() - Method in class com.contentstack.cms.stack.Webhook
-
The Export a Webhook request exports an existing webhook.
- export(int) - Method in class com.contentstack.cms.stack.ContentType
-
Export Content Type.
- export(String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.ContentTypeService
- export(String, Map<String, Object>, int) - Method in interface com.contentstack.cms.stack.ContentTypeService
- export(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.GlobalFieldService
- export(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.WebhookService
- export(Map<String, Object>, String, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.EntryService
- extensions() - Method in class com.contentstack.cms.stack.Stack
-
Extensions let you create custom fields and custom widgets that lets you customize Contentment's default UI and behavior.
- extensions(String) - Method in class com.contentstack.cms.stack.Stack
-
Extensions let you create custom fields and custom widgets that lets you customize Contentment's default UI and behavior.
- Extensions - Class in com.contentstack.cms.stack
-
Extensions let you create custom fields and custom widgets that lets you customize Contentstack default UI and behavior.
- Extensions(Retrofit) - Constructor for class com.contentstack.cms.stack.Extensions
- Extensions(Retrofit, String) - Constructor for class com.contentstack.cms.stack.Extensions
- ExtensionsService - Interface in com.contentstack.cms.stack
F
- failedAttempts - Variable in class com.contentstack.cms.models.UserModel
- fetch() - Method in class com.contentstack.cms.organization.Organization
-
Get a single organization
The Get a single organization call gets the comprehensive details of a specific organization related to the system user
Organization.addParam(String, Object)
the Query Parameters include_plan(optional) = true - fetch() - Method in class com.contentstack.cms.stack.Alias
-
The Get a single alias request returns information of a specific alias.
- fetch() - Method in class com.contentstack.cms.stack.Asset
-
The Get an asset call returns comprehensive information about a specific version of an asset of a stack
- fetch() - Method in class com.contentstack.cms.stack.AuditLog
-
The Get audit log item request is used to retrieve a specific item from the audit log of a stack.
- fetch() - Method in class com.contentstack.cms.stack.Branch
-
The Get a single branch request returns information of a specific branch.
- fetch() - Method in class com.contentstack.cms.stack.ContentType
-
Get Single Content Type
- fetch() - Method in class com.contentstack.cms.stack.DeliveryToken
-
The Get a single delivery token request returns the details of all the delivery tokens created in a stack.
- fetch() - Method in class com.contentstack.cms.stack.Entry
-
The Get a single entry request fetches a particular entry of a content type.
- fetch() - Method in class com.contentstack.cms.stack.Environment
-
The Get a single environment call returns more details about the specified environment of a stack.
- fetch() - Method in class com.contentstack.cms.stack.Extensions
- fetch() - Method in class com.contentstack.cms.stack.Folder
-
The Get a single folder call gets the comprehensive details of a specific asset folder by means of folder UID.
- fetch() - Method in class com.contentstack.cms.stack.GlobalField
-
Get Single Global Field:
- fetch() - Method in class com.contentstack.cms.stack.Label
-
The Get label call returns information about a particular label of a stack.
- fetch() - Method in class com.contentstack.cms.stack.Locale
-
The Get a language call returns information about a specific language available on the stack.
- fetch() - Method in class com.contentstack.cms.stack.ManagementToken
-
The Get a single management token request returns the details of a specific management token generated in a stack and NOT the actual management token.
- fetch() - Method in class com.contentstack.cms.stack.Release
-
The Get a single Release request gets the details of a specific Release in a stack.
- fetch() - Method in class com.contentstack.cms.stack.Roles
-
The Get a single role request returns comprehensive information on a specific role.
- fetch() - Method in class com.contentstack.cms.stack.Webhook
-
The Get webhook request returns comprehensive information on a specific webhook.
- fetch() - Method in class com.contentstack.cms.stack.Workflow
-
Get a Single Workflow request retrieves the comprehensive details of a specific Workflow of a stack.
- fetch(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.AuditLogService
- fetch(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.EntryService
- fetch(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.ReleaseService
- fetch(Map<String, Object>, HashMap<String, Object>) - Method in interface com.contentstack.cms.stack.AuditLogService
- fetch(Map<String, Object>, HashMap<String, Object>) - Method in interface com.contentstack.cms.stack.PublishQueueService
- fetch(Map<String, Object>, HashMap<String, Object>) - Method in interface com.contentstack.cms.stack.WebhookService
- fetch(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.AliasService
- fetch(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.AssetService
- fetch(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.BranchService
- fetch(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.ContentTypeService
- fetch(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.EnvironmentService
- fetch(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.GlobalFieldService
- fetch(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.ReleaseService
- fetch(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.StackService
- fetch(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.WorkflowService
- fetch(Map<String, String>, Map<String, Object>) - Method in interface com.contentstack.cms.organization.OrganizationService
- fetchActivity() - Method in class com.contentstack.cms.stack.PublishQueue
-
Get publish queue activity request returns comprehensive information on a specific publish, unpublish, or delete action that was performed on an entry and/or asset.
- fetchActivity(Map<String, Object>, String, HashMap<String, Object>) - Method in interface com.contentstack.cms.stack.PublishQueueService
- fetchManagementToken(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.TokenService
- fetchPublishRule(String) - Method in class com.contentstack.cms.stack.Workflow
-
The Get a Single Publish Rule request retrieves the comprehensive details of a specific publish rule of a Workflow.
- fetchPublishRuleContentType(String) - Method in class com.contentstack.cms.stack.Workflow
-
The Get Publish Rules by Content Types request allows you to retrieve details of a Publish Rule applied to a specific content type of your stack.
- fetchPublishRuleContentType(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.WorkflowService
- fetchPublishRules(List<String>) - Method in class com.contentstack.cms.stack.Workflow
-
The Get all Publish Rules request retrieves the details of all the Publishing rules of a workflow.
- fetchPublishRules(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.WorkflowService
- fetchPublishRules(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.WorkflowService
- fetchTasks() - Method in class com.contentstack.cms.stack.Workflow
-
The Get all Tasks request retrieves a list of all tasks assigned to you.
- fetchTasks(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.WorkflowService
- fieldVisibilityRule(JSONObject) - Method in class com.contentstack.cms.stack.ContentType
-
Field visibility rule.
- find() - Method in class com.contentstack.cms.organization.Organization
-
Gets all organizations.
The Get all organizations call lists all organizations related to the system user in the order that they were created
Organization.addParam(String, Object)
queryParams the query params query parameters are below
limit(optional) The limit parameter will return a specific number of Organization roles in the output. - find() - Method in class com.contentstack.cms.stack.Alias
-
The Get all aliases request returns comprehensive information of all the aliases available in a particular stack in your account.
- find() - Method in class com.contentstack.cms.stack.Asset
-
The Get all assets request returns comprehensive information on all assets available in a stack.
- find() - Method in class com.contentstack.cms.stack.AuditLog
-
The Get audit log request is used to retrieve the audit log of a stack.
- find() - Method in class com.contentstack.cms.stack.Branch
-
The Get all branches request returns comprehensive information of all the branches available in a particular stack in your account.
- find() - Method in class com.contentstack.cms.stack.ContentType
-
Fetch call. The Get all content types call returns comprehensive information of all the content types available in a particular stack in your account.
- find() - Method in class com.contentstack.cms.stack.DeliveryToken
-
The Get all delivery tokens request returns the details of all the delivery tokens created in a stack.
- find() - Method in class com.contentstack.cms.stack.Entry
-
Fetches the list of all the entries of a particular content type. It also returns the content of each entry in JSON format.
- find() - Method in class com.contentstack.cms.stack.Environment
-
The Get all environments call fetches the list of all environments available in a stack.
- find() - Method in class com.contentstack.cms.stack.Extensions
-
The Get all custom fields request is used to get the information of all custom fields created in a stack.
- find() - Method in class com.contentstack.cms.stack.GlobalField
-
Get All Global Fields
- find() - Method in class com.contentstack.cms.stack.Label
-
This call fetches all the existing labels of the stack.
- find() - Method in class com.contentstack.cms.stack.Locale
-
Get all languages
This call fetches the list of all languages (along with the language codes) available for a stack. - find() - Method in class com.contentstack.cms.stack.ManagementToken
-
The Get all management tokens request returns the details of all the management tokens generated in a stack and NOT the actual management tokens.
- find() - Method in class com.contentstack.cms.stack.PublishQueue
-
The Get publish queue request returns comprehensive information on activities such as publish, unpublish, and delete that have performed on entries and/or assets.
- find() - Method in class com.contentstack.cms.stack.Release
-
The Get all Releases request retrieves a list of all Releases of a stack along with details of each Release.
- find() - Method in class com.contentstack.cms.stack.ReleaseItem
-
The Get all items in a Release request retrieves a list of all items (entries and assets) that are part of a specific Release.
- find() - Method in class com.contentstack.cms.stack.Roles
-
The Get all roles request returns comprehensive information about all roles created in a stack.
- find() - Method in class com.contentstack.cms.stack.Stack
-
Get stacks
All Stack:- authtoken is required to fetch all the stacks
Single Stack:- : api_key and authtoken is required and organization_uid is optional
Example: - find() - Method in class com.contentstack.cms.stack.Webhook
-
The Get all Webhooks request returns comprehensive information on all the available webhooks in the specified stack
When executing the API call, under the Header section, you need to enter the authtoken that you receive after logging into your account. - find() - Method in class com.contentstack.cms.stack.Workflow
-
Get a Single Workflow request retrieves the comprehensive details of a specific Workflow of a stack.
- fine(String) - Method in class com.contentstack.cms.core.CMALogger
- finer(String) - Method in class com.contentstack.cms.core.CMALogger
- firstName - Variable in class com.contentstack.cms.models.UserModel
- folder() - Method in class com.contentstack.cms.stack.Asset
-
Gets folder instance
- folder(String) - Method in class com.contentstack.cms.stack.Asset
-
Gets folder instance
- Folder - Class in com.contentstack.cms.stack
- Folder(Retrofit) - Constructor for class com.contentstack.cms.stack.Folder
- Folder(Retrofit, String) - Constructor for class com.contentstack.cms.stack.Folder
G
- generatePermanentUrl(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.AssetService
- generatePermanentUrl(JSONObject) - Method in class com.contentstack.cms.stack.Asset
-
Generate Permanent Asset URL request allows you to generate a permanent URL for an asset.
- get(Map<String, Object>) - Method in interface com.contentstack.cms.stack.LabelService
- get(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.LabelService
- get(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.LabelService
- get(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.LabelService
- getAll(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.ExtensionsService
- getAllInvitations(Map<String, String>, String, Map<String, Object>) - Method in interface com.contentstack.cms.organization.OrganizationService
- getByType(String) - Method in class com.contentstack.cms.stack.Asset
-
Get either only images or videos request retrieves assets that are either image or video files, based on query request.
- getByType(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.AssetService
- getDeliveryToken(Map<String, Object>) - Method in interface com.contentstack.cms.stack.TokenService
- getDeliveryToken(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.TokenService
- getEnv(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.EnvironmentService
- getExecutionLog(String) - Method in class com.contentstack.cms.stack.Webhook
-
This call will return a comprehensive detail of all the webhooks that were executed at a particular execution cycle.
- getExecutionLog(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.WebhookService
- getExecutions() - Method in class com.contentstack.cms.stack.Webhook
-
The Get executions of a webhook request allows you to fetch the execution details of a specific webhook, which includes the execution UID.
- getExecutions(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.WebhookService
- getLanguage() - Method in class com.contentstack.cms.stack.Entry
-
The Get languages of an entry call returns the details of all the languages that an entry exists in
- getLogDetails(Map<String, String>, String) - Method in interface com.contentstack.cms.organization.OrganizationService
- getLogger() - Method in class com.contentstack.cms.core.CMALogger
- getLogItems(Map<String, String>, String, String) - Method in interface com.contentstack.cms.organization.OrganizationService
- getPermanentUrl(String) - Method in class com.contentstack.cms.stack.Asset
-
The Download an asset with permanent URL request displays an asset in the response.
- getReference() - Method in class com.contentstack.cms.stack.Entry
-
The Get references of an entry call returns all the entries of content types that are referenced by a particular entry.
- getReferences() - Method in class com.contentstack.cms.stack.Asset
-
Get asset references request returns the details of the entries and the content types in which the specified asset is referenced
- getReferences(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.AssetService
- getRole(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.RolesService
- getRoles(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.RolesService
- getRoles(Map<String, String>, String, Map<String, Object>) - Method in interface com.contentstack.cms.organization.OrganizationService
- getSingle(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.ExtensionsService
- getSingle(Map<String, String>, String, Map<String, Object>) - Method in interface com.contentstack.cms.organization.OrganizationService
- getSingleFolderByName() - Method in class com.contentstack.cms.stack.Asset
-
The Get a single folder by name call retrieves a specific asset folder based on the name provided.
- getSingleManagementToken(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.TokenService
- getStacks(Map<String, String>, String, Map<String, Object>) - Method in interface com.contentstack.cms.organization.OrganizationService
- getSubfolder() - Method in class com.contentstack.cms.stack.Asset
-
Get subfolders of a parent folder request retrieves the details of only the subfolders of a specific asset folder.
- getSubfolder(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.AssetService
- getUser() - Method in class com.contentstack.cms.user.User
-
The Get user call returns comprehensive information of an existing user account.
- getUser() - Method in interface com.contentstack.cms.user.UserService
- getVersionNameDetails() - Method in class com.contentstack.cms.stack.Asset
-
Get Details of All Versions of an Asset
- getVersionNameDetails(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.AssetService
- globalField() - Method in class com.contentstack.cms.stack.Stack
-
A Global field is a reusable field (or group of fields) that you can define once and reuse in any content type within your stack.
- globalField(String) - Method in class com.contentstack.cms.stack.Stack
-
A Global field is a reusable field (or group of fields) that you can define once and reuse in any content type within your stack.
- GlobalField - Class in com.contentstack.cms.stack
-
A Global field is a reusable field (or group of fields) that you can define once and reuse in any content type within your stack.
- GlobalField(Retrofit) - Constructor for class com.contentstack.cms.stack.GlobalField
- GlobalField(Retrofit, String) - Constructor for class com.contentstack.cms.stack.GlobalField
- GlobalFieldService - Interface in com.contentstack.cms.stack
- globalFiledUid - Variable in class com.contentstack.cms.stack.GlobalField
H
- headers - Variable in class com.contentstack.cms.organization.Organization
- headers - Variable in class com.contentstack.cms.stack.Alias
- headers - Variable in class com.contentstack.cms.stack.Asset
- headers - Variable in class com.contentstack.cms.stack.AuditLog
- headers - Variable in class com.contentstack.cms.stack.Branch
- headers - Variable in class com.contentstack.cms.stack.ContentType
- headers - Variable in class com.contentstack.cms.stack.DeliveryToken
- headers - Variable in class com.contentstack.cms.stack.Entry
- headers - Variable in class com.contentstack.cms.stack.Environment
- headers - Variable in class com.contentstack.cms.stack.Extensions
- headers - Variable in class com.contentstack.cms.stack.Folder
- headers - Variable in class com.contentstack.cms.stack.GlobalField
- headers - Variable in class com.contentstack.cms.stack.Label
- headers - Variable in class com.contentstack.cms.stack.Locale
- headers - Variable in class com.contentstack.cms.stack.ManagementToken
- headers - Variable in class com.contentstack.cms.stack.PublishQueue
- headers - Variable in class com.contentstack.cms.stack.Release
- headers - Variable in class com.contentstack.cms.stack.ReleaseItem
- headers - Variable in class com.contentstack.cms.stack.Roles
- headers - Variable in class com.contentstack.cms.stack.Stack
- headers - Variable in class com.contentstack.cms.stack.Webhook
- headers - Variable in class com.contentstack.cms.stack.Workflow
- host - Variable in class com.contentstack.cms.Contentstack
- HOST - Static variable in class com.contentstack.cms.core.Util
I
- ILLEGAL_USER - Static variable in class com.contentstack.cms.core.Util
- importExisting() - Method in class com.contentstack.cms.stack.Entry
-
The Import an existing entry call will import a new version of an existing entry.
- importExisting() - Method in class com.contentstack.cms.stack.Webhook
-
The Import an Existing Webhook request will allow you to update the details of an existing webhook.
- importExisting(Map<String, Object>) - Method in interface com.contentstack.cms.stack.WebhookService
- importExisting(Map<String, Object>, String, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.EntryService
- importOverwrite() - Method in class com.contentstack.cms.stack.ContentType
-
Import content type
- importOverwrite(Map<String, Object>) - Method in interface com.contentstack.cms.stack.ContentTypeService
- imports() - Method in class com.contentstack.cms.stack.ContentType
-
Import content type
The Import a content type call imports a content type into a stack by uploading JSON file. - imports() - Method in class com.contentstack.cms.stack.Entry
-
The Import an entry call is used to import an entry.
- imports(JSONObject) - Method in class com.contentstack.cms.stack.GlobalField
-
Import a global field The
Import global field
call imports global fields into Stack
[Note] - imports(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.EntryService
- imports(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.ContentTypeService
- imports(Map<String, Object>, RequestBody) - Method in interface com.contentstack.cms.stack.WebhookService
- imports(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.GlobalFieldService
- importWebhook(String, String) - Method in class com.contentstack.cms.stack.Webhook
-
The Import Webhook section consists of the following two requests that will help you to import new Webhooks or update existing ones by uploading JSON files.
- info(String) - Method in class com.contentstack.cms.core.CMALogger
- instance - Variable in class com.contentstack.cms.Contentstack
- instance - Variable in class com.contentstack.cms.stack.ContentType
- intercept(Interceptor.Chain) - Method in class com.contentstack.cms.core.AuthInterceptor
- interceptor - Variable in class com.contentstack.cms.Contentstack
- inviteUser(Map<String, String>, String, JSONObject) - Method in interface com.contentstack.cms.organization.OrganizationService
- inviteUser(JSONObject) - Method in class com.contentstack.cms.organization.Organization
-
Gets organization users.
- item() - Method in class com.contentstack.cms.stack.Release
-
The Get all items in a Release request retrieves a list of all items (entries and assets) that are part of a specific Release and perform CRUD operations on it.
L
- label() - Method in class com.contentstack.cms.stack.Stack
-
Labels allow you to group a collection of content within a stack.
- label(String) - Method in class com.contentstack.cms.stack.Stack
-
Labels allow you to group a collection of content within a stack.
- Label - Class in com.contentstack.cms.stack
-
Labels allow you to group a collection of content within a stack.
- Label(Retrofit) - Constructor for class com.contentstack.cms.stack.Label
- Label(Retrofit, String) - Constructor for class com.contentstack.cms.stack.Label
- LabelService - Interface in com.contentstack.cms.stack
- labelUid - Variable in class com.contentstack.cms.stack.Label
- language(Map<String, Object>, String, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.EntryService
- lastName - Variable in class com.contentstack.cms.models.UserModel
- locale() - Method in class com.contentstack.cms.stack.Stack
-
Contentstack has a sophisticated multilingual capability.
- locale(String) - Method in class com.contentstack.cms.stack.Stack
-
Contentstack has a sophisticated multilingual capability.
- Locale - Class in com.contentstack.cms.stack
-
Languages
Contentstack has a sophisticated multilingual capability. - Locale(Retrofit) - Constructor for class com.contentstack.cms.stack.Locale
-
Instantiates a new Language
- Locale(Retrofit, String) - Constructor for class com.contentstack.cms.stack.Locale
- locales(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.LocaleService
- localeService - Variable in class com.contentstack.cms.stack.Locale
- LocaleService - Interface in com.contentstack.cms.stack
- localize(JSONObject, String) - Method in class com.contentstack.cms.stack.Entry
-
To Localize an entry request allows you to localize an entry i.e., the entry will cease to fetch data from its fallback language and possess independent content specific to the selected locale.
- localize(Map<String, Object>, String, String, String, JSONObject) - Method in interface com.contentstack.cms.stack.EntryService
- logger - Variable in class com.contentstack.cms.Contentstack
- login(String, String) - Method in class com.contentstack.cms.user.User
-
The Log in to your account request is used to sign in to your Contentstack account and obtain the authtoken.
- login(String, String, String) - Method in class com.contentstack.cms.user.User
-
Login call.
- login(String, String) - Method in class com.contentstack.cms.Contentstack
-
[Note]: Before executing any calls, retrieve the authtoken by authenticating yourself via the Log in call of User Session.
- login(String, String, String) - Method in class com.contentstack.cms.Contentstack
-
[Note]: Before executing any calls, retrieve the authtoken by authenticating yourself via the Log in call of User Session.
- login(Map<String, String>, JSONObject) - Method in interface com.contentstack.cms.user.UserService
- LOGIN_FLAG - Static variable in class com.contentstack.cms.core.Util
- LoginDetails - Class in com.contentstack.cms.models
- LoginDetails() - Constructor for class com.contentstack.cms.models.LoginDetails
- logItem(String) - Method in class com.contentstack.cms.organization.Organization
-
Gets organization logs.
- logout() - Method in class com.contentstack.cms.user.User
-
The Log out of your account call is used to sign out the user of Contentstack account
- logout() - Method in interface com.contentstack.cms.user.UserService
- logout(String) - Method in interface com.contentstack.cms.user.UserService
- logoutWithAuthtoken(String) - Method in class com.contentstack.cms.user.User
-
The Log out of your account call is used to sign out the user of Contentstack account
- logsDetails() - Method in class com.contentstack.cms.organization.Organization
-
Gets organization logs.
M
- managementToken() - Method in class com.contentstack.cms.stack.Tokens
-
To authenticate Content Management API (CMA) requests over your stack content, you can use Management Tokens
- managementToken(String) - Method in class com.contentstack.cms.stack.Tokens
-
To authenticate Content Management API (CMA) requests over your stack content, you can use Management Tokens
- ManagementToken - Class in com.contentstack.cms.stack
-
Management tokens:
To authenticate Content Management API (CMA) requests over your stack content, you can use Management Tokens - ManagementToken(TokenService) - Constructor for class com.contentstack.cms.stack.ManagementToken
- ManagementToken(TokenService, String) - Constructor for class com.contentstack.cms.stack.ManagementToken
- MULTIPART - Static variable in class com.contentstack.cms.core.Util
N
- notice - Variable in class com.contentstack.cms.models.LoginDetails
- nullEmptyThrowsException(String) - Static method in class com.contentstack.cms.core.Util
- NullKeyException - Exception in com.contentstack.cms.core
- NullKeyException() - Constructor for exception com.contentstack.cms.core.NullKeyException
- NullKeyException(String) - Constructor for exception com.contentstack.cms.core.NullKeyException
-
Constructs a new exception with the specified detail message.
O
- onFailure(Call<T>, Throwable) - Method in class com.contentstack.cms.core.RetryCallback
- organization() - Method in class com.contentstack.cms.Contentstack
-
Organization is the top-level entity in the hierarchy of Contentstack, consisting of stacks and stack resources, and users.
- organization(String) - Method in class com.contentstack.cms.Contentstack
-
Organization is the top-level entity in the hierarchy of Contentstack, consisting of stacks and stack resources, and users.
- Organization - Class in com.contentstack.cms.organization
-
Organization is the top-level entity in the hierarchy of Contentstack, consisting of stacks and stack resources, and users.
- Organization(Retrofit) - Constructor for class com.contentstack.cms.organization.Organization
-
Instantiates a new Organization.
- Organization(Retrofit, String) - Constructor for class com.contentstack.cms.organization.Organization
-
Instantiates a new Organization.
- organizations - Variable in class com.contentstack.cms.models.UserModel
- OrganizationService - Interface in com.contentstack.cms.organization
- orgUid - Variable in class com.contentstack.cms.models.UserModel
P
- params - Variable in class com.contentstack.cms.organization.Organization
- params - Variable in class com.contentstack.cms.stack.Alias
- params - Variable in class com.contentstack.cms.stack.Asset
- params - Variable in class com.contentstack.cms.stack.AuditLog
- params - Variable in class com.contentstack.cms.stack.Branch
- params - Variable in class com.contentstack.cms.stack.ContentType
- params - Variable in class com.contentstack.cms.stack.DeliveryToken
- params - Variable in class com.contentstack.cms.stack.Entry
- params - Variable in class com.contentstack.cms.stack.Environment
- params - Variable in class com.contentstack.cms.stack.Extensions
- params - Variable in class com.contentstack.cms.stack.Folder
- params - Variable in class com.contentstack.cms.stack.GlobalField
- params - Variable in class com.contentstack.cms.stack.Label
- params - Variable in class com.contentstack.cms.stack.Locale
- params - Variable in class com.contentstack.cms.stack.ManagementToken
- params - Variable in class com.contentstack.cms.stack.PublishQueue
- params - Variable in class com.contentstack.cms.stack.Release
- params - Variable in class com.contentstack.cms.stack.ReleaseItem
- params - Variable in class com.contentstack.cms.stack.Roles
- params - Variable in class com.contentstack.cms.stack.Stack
- params - Variable in class com.contentstack.cms.stack.Webhook
- params - Variable in class com.contentstack.cms.stack.Workflow
- PLEASE_LOGIN - Static variable in class com.contentstack.cms.core.Util
- port - Variable in class com.contentstack.cms.Contentstack
- PORT - Static variable in class com.contentstack.cms.core.Util
- profileType - Variable in class com.contentstack.cms.models.UserModel
- PROTOCOL - Static variable in class com.contentstack.cms.core.Util
- proxy - Variable in class com.contentstack.cms.Contentstack.Builder
-
The Proxy.
- proxy - Variable in class com.contentstack.cms.Contentstack
- publish(JSONObject) - Method in class com.contentstack.cms.stack.Asset
-
Publish an asset call is used to publish a specific version of an asset on the desired environment either immediately or at a later date/time.
- publish(JSONObject) - Method in class com.contentstack.cms.stack.Entry
-
To Publish an entry request lets you publish an entry either immediately or schedule it for a later date/time.
- publish(Map<String, Object>, String, String, JSONObject) - Method in interface com.contentstack.cms.stack.EntryService
- publish(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.AssetService
- publishQueue() - Method in class com.contentstack.cms.stack.Stack
-
The Publishing Queue displays the historical and current details of activities such as publish, unpublish, or delete that can be performed on entries and/or assets.
- publishQueue(String) - Method in class com.contentstack.cms.stack.Stack
-
The Publishing Queue displays the historical and current details of activities such as publish, unpublish, or delete that can be performed on entries and/or assets.
- PublishQueue - Class in com.contentstack.cms.stack
-
The Publish Queue displays the historical and current details of activities such as publish, unpublish, or delete that can be performed on entries and/or assets.
- PublishQueue(Retrofit) - Constructor for class com.contentstack.cms.stack.PublishQueue
- PublishQueue(Retrofit, String) - Constructor for class com.contentstack.cms.stack.PublishQueue
- PublishQueueService - Interface in com.contentstack.cms.stack
- publishRequestApproval(Map<String, Object>, String, String, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.WorkflowService
- publishWithReference(JSONObject) - Method in class com.contentstack.cms.stack.Entry
-
The Publishing an Entry With References request allows you to publish an entry along with all its references at the same time.
- publishWithReference(Map<String, Object>, JSONObject, Map<String, Object>) - Method in interface com.contentstack.cms.stack.EntryService
R
- reference(Boolean) - Method in class com.contentstack.cms.stack.ContentType
-
Content Type References.
- reference(String, Map<String, Object>, Boolean) - Method in interface com.contentstack.cms.stack.ContentTypeService
- reference(Map<String, Object>, String, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.EntryService
- referenceIncludeGlobalField() - Method in class com.contentstack.cms.stack.ContentType
-
Content Type References.
- referenceIncludeGlobalField(String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.ContentTypeService
- Release - Class in com.contentstack.cms.stack
-
You can pin a set of entries and assets (along with the deploy action, i.e., publish/unpublish) to a ‘release’, and then deploy this release to an environment.
- Release(Retrofit) - Constructor for class com.contentstack.cms.stack.Release
- Release(Retrofit, String) - Constructor for class com.contentstack.cms.stack.Release
- ReleaseItem - Class in com.contentstack.cms.stack
-
The Get all items in a Release request retrieves a list of all items (entries and assets) that are part of a specific Release and perform CRUD operations on it.
- ReleaseItem(Retrofit, String) - Constructor for class com.contentstack.cms.stack.ReleaseItem
- releases() - Method in class com.contentstack.cms.stack.Stack
-
You can pin a set of entries and assets (along with the deploy action, i.e., publish/unpublish) to a release, and then deploy this release to an environment.
- releases(String) - Method in class com.contentstack.cms.stack.Stack
-
You can pin a set of entries and assets (along with the deploy action, i.e., publish/unpublish) to a release, and then deploy this release to an environment.
- ReleaseService - Interface in com.contentstack.cms.stack
- releaseUid - Variable in class com.contentstack.cms.stack.Release
- removeItem(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.ReleaseService
- removeParam(String) - Method in class com.contentstack.cms.organization.Organization
-
Sets header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.Alias
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.Asset
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.AuditLog
-
Sets header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.Branch
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.ContentType
-
Sets header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.DeliveryToken
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.Entry
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.Environment
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.Extensions
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.Folder
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.GlobalField
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.Label
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.Locale
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.ManagementToken
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.PublishQueue
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.Release
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.ReleaseItem
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.Roles
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.Stack
-
Sets header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.Webhook
-
Set header for the request
- removeParam(String) - Method in class com.contentstack.cms.stack.Workflow
-
Set header for the request
- removeUser(Map<String, String>, String, JSONObject) - Method in interface com.contentstack.cms.organization.OrganizationService
- removeUsers(JSONObject) - Method in class com.contentstack.cms.organization.Organization
-
Remove users from organization
Note: Only the owner or the admin of the organization can remove users
The Remove users from organization request allows you to remove existing users from your organization - replace(String, String) - Method in class com.contentstack.cms.stack.Asset
-
The Replace asset call will replace an existing asset with another file on the stack.
- replace(Map<String, Object>, String, MultipartBody.Part, RequestBody, Map<String, Object>) - Method in interface com.contentstack.cms.stack.AssetService
- requestBody(Call) - Method in class com.contentstack.cms.core.CMAResponseConvertor
- requestPassword(JSONObject) - Method in class com.contentstack.cms.user.User
-
The Request for a password call sends a request for a temporary password to log in to an account in case a user has forgotten the login password.
- requestPassword(JSONObject) - Method in interface com.contentstack.cms.user.UserService
- resendInvitation(String) - Method in class com.contentstack.cms.organization.Organization
-
Resend pending organization invitations call.
- resendInvitation(Map<String, String>, String, String) - Method in interface com.contentstack.cms.organization.OrganizationService
- resetPassword(JSONObject) - Method in class com.contentstack.cms.user.User
-
The Reset password call sends a request for resetting the password of your Contentstack account.
- resetPassword(JSONObject) - Method in interface com.contentstack.cms.user.UserService
- resetSetting(JSONObject) - Method in class com.contentstack.cms.stack.Stack
-
Reset stack settings
- retry(String) - Method in class com.contentstack.cms.stack.Webhook
-
This call makes a manual attempt to execute a webhook after the webhook has finished executing its automatic attempts.
- retry(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.WebhookService
- RETRY_ON_FAILURE - Static variable in class com.contentstack.cms.core.Util
- RetryCallback<T> - Class in com.contentstack.cms.core
-
The Contentstack RetryCallback
- RetryCallback(Call<T>) - Constructor for class com.contentstack.cms.core.RetryCallback
-
Instantiates a new Callback with retry.
- retryOnFailure - Variable in class com.contentstack.cms.Contentstack
- roles - Variable in class com.contentstack.cms.models.UserModel
- roles() - Method in class com.contentstack.cms.organization.Organization
-
Gets organization role.
- roles() - Method in class com.contentstack.cms.stack.Stack
-
A role is a collection of permissions that will be applicable to all the users who are assigned this role
- roles(JSONObject) - Method in class com.contentstack.cms.stack.Stack
-
Update User Role
- roles(String) - Method in class com.contentstack.cms.stack.Stack
-
A role is a collection of permissions that will be applicable to all the users who are assigned this role
- Roles - Class in com.contentstack.cms.stack
-
A role is a collection of permissions that will be applicable to all the users who are assigned this role.
- Roles(Retrofit) - Constructor for class com.contentstack.cms.stack.Roles
- Roles(Retrofit, String) - Constructor for class com.contentstack.cms.stack.Roles
- RolesService - Interface in com.contentstack.cms.stack
- roleUid - Variable in class com.contentstack.cms.stack.Roles
- rteInfo(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.AssetService
- rteInformation() - Method in class com.contentstack.cms.stack.Asset
-
The Get information on RTE assets call returns comprehensive information on all assets uploaded through the Rich Text Editor field.
S
- SDK_NAME - Static variable in class com.contentstack.cms.core.Util
- SDK_VERSION - Static variable in class com.contentstack.cms.core.Util
- service - Variable in class com.contentstack.cms.stack.Alias
- service - Variable in class com.contentstack.cms.stack.Asset
- service - Variable in class com.contentstack.cms.stack.AuditLog
- service - Variable in class com.contentstack.cms.stack.Branch
- service - Variable in class com.contentstack.cms.stack.ContentType
- service - Variable in class com.contentstack.cms.stack.DeliveryToken
- service - Variable in class com.contentstack.cms.stack.Entry
- service - Variable in class com.contentstack.cms.stack.Environment
- service - Variable in class com.contentstack.cms.stack.Extensions
- service - Variable in class com.contentstack.cms.stack.Folder
- service - Variable in class com.contentstack.cms.stack.GlobalField
-
The Service.
- service - Variable in class com.contentstack.cms.stack.Label
- service - Variable in class com.contentstack.cms.stack.ManagementToken
- service - Variable in class com.contentstack.cms.stack.PublishQueue
- service - Variable in class com.contentstack.cms.stack.Release
- service - Variable in class com.contentstack.cms.stack.ReleaseItem
- service - Variable in class com.contentstack.cms.stack.Roles
- service - Variable in class com.contentstack.cms.stack.Tokens
- service - Variable in class com.contentstack.cms.stack.Webhook
- service - Variable in class com.contentstack.cms.stack.Workflow
- setAuthtoken(String) - Method in class com.contentstack.cms.Contentstack.Builder
-
Sets authtoken for the client
- setAuthtoken(String) - Method in class com.contentstack.cms.core.AuthInterceptor
- setFallback(JSONObject) - Method in class com.contentstack.cms.stack.Locale
-
The Set a fallback language request allows you to assign a fallback language for an entry in a particular language.
- setFallback(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.LocaleService
- setHost(String) - Method in class com.contentstack.cms.Contentstack.Builder
-
Set host for client instance
- setPort(String) - Method in class com.contentstack.cms.Contentstack.Builder
-
Set port for client instance
- setProxy(Proxy) - Method in class com.contentstack.cms.Contentstack.Builder
-
Sets proxy.
- setRetry(Boolean) - Method in class com.contentstack.cms.Contentstack.Builder
-
Sets retry on failure.
- setTimeout(int) - Method in class com.contentstack.cms.Contentstack.Builder
-
Set timeout for client instance
- setting() - Method in class com.contentstack.cms.stack.Stack
-
Stack Settings The Get stack settings call retrieves the configuration settings of an existing stack.
*(Read more) - setting(Map<String, Object>) - Method in interface com.contentstack.cms.stack.StackService
- setVersion(String) - Method in class com.contentstack.cms.Contentstack.Builder
-
Set version for client instance
- setVersionName(int, JSONObject) - Method in class com.contentstack.cms.stack.Asset
-
Version naming allows you to assign a name to a version of an asset for easy identification.
- setVersionName(Map<String, Object>, String, int, JSONObject) - Method in interface com.contentstack.cms.stack.AssetService
- severe(String) - Method in class com.contentstack.cms.core.CMALogger
- share(JSONObject) - Method in class com.contentstack.cms.stack.Stack
-
Share a stack
- share(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.StackService
- sharedOrgUid - Variable in class com.contentstack.cms.models.UserModel
- singel(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.LocaleService
- single(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.AliasService
- single(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.BranchService
- single(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.ReleaseService
- single(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.WebhookService
- single(Map<String, Object>, String) - Method in interface com.contentstack.cms.stack.WorkflowService
- single(Map<String, Object>, String, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.EntryService
- single(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.AssetService
- single(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.ContentTypeService
- single(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.GlobalFieldService
- singleFolder(Map<String, Object>, String, Map<String, Object>) - Method in interface com.contentstack.cms.stack.AssetService
- singleFolderByName(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.AssetService
- specificFolder(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.AssetService
- stack() - Method in class com.contentstack.cms.Contentstack
-
stack A stack is a space that stores the content of a project (a web or mobile property).
- stack(String) - Method in class com.contentstack.cms.Contentstack
-
stack A stack is a space that stores the content of a project (a web or mobile property).
- stack(String, String) - Method in class com.contentstack.cms.Contentstack
-
stack A stack is a space that stores the content of a project (a web or mobile property).
- stack(String, String, String) - Method in class com.contentstack.cms.Contentstack
-
stack A stack is a space that stores the content of a project (a web or mobile property).
- stack(Map<String, Object>) - Method in class com.contentstack.cms.Contentstack
-
stack A stack is a space that stores the content of a project (a web or mobile property).
- Stack - Class in com.contentstack.cms.stack
-
A stack is a space that stores the content of a project (a web or mobile property).
- Stack(Retrofit) - Constructor for class com.contentstack.cms.stack.Stack
-
Instantiates a new Stack.
- Stack(Retrofit, Map<String, Object>) - Constructor for class com.contentstack.cms.stack.Stack
-
Instantiates a new Stack.
- stacks() - Method in class com.contentstack.cms.organization.Organization
-
Gets all stacks in an organizations.
- StackService - Interface in com.contentstack.cms.stack
- subfolder(String, Boolean) - Method in class com.contentstack.cms.stack.Asset
-
The Get assets and folders of a parent folder retrieves details of both assets and asset subfolders within a specific parent asset folder.
- subfolder(Map<String, Object>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.AssetService
T
- timeout - Variable in class com.contentstack.cms.Contentstack
- TIMEOUT - Static variable in class com.contentstack.cms.core.Util
- tokens() - Method in class com.contentstack.cms.stack.Stack
-
Contentstack provides different types of tokens to authorize API requests.
- Tokens - Class in com.contentstack.cms.stack
-
Tokens
Contentstack provides different types of tokens to authorize API requests - Tokens(Retrofit) - Constructor for class com.contentstack.cms.stack.Tokens
- TokenService - Interface in com.contentstack.cms.stack
- toModel(Class<T>) - Method in class com.contentstack.cms.core.CMAResponseConvertor
- toModel(Class<T>, String) - Method in class com.contentstack.cms.core.CMAResponseConvertor
- toModel(Class<T>, Response<ResponseBody>) - Method in class com.contentstack.cms.core.CMAResponseConvertor
- toRequestBody(String) - Static method in class com.contentstack.cms.core.Util
- transferOwnership(JSONObject) - Method in class com.contentstack.cms.stack.Stack
-
Transfer Stack Ownership
The Transfer stack ownership to other users call sends the specified user an email invitation for accepting the ownership of a particular stack. - transferOwnership(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.StackService
- transferOwnership(Map<String, String>, String, JSONObject) - Method in interface com.contentstack.cms.organization.OrganizationService
- transferOwnership(JSONObject) - Method in class com.contentstack.cms.organization.Organization
-
Transfer organizations ownership call.
The Transfer organization ownership call transfers the ownership of an Organization to another user.
U
- uid - Variable in class com.contentstack.cms.models.UserModel
- unLocalize(String) - Method in class com.contentstack.cms.stack.Entry
-
The Unlocalize an entry request is used to unlocalize an existing entry.
- unLocalize(Map<String, Object>, String, String, String) - Method in interface com.contentstack.cms.stack.EntryService
- unpublish(JSONObject) - Method in class com.contentstack.cms.stack.Asset
-
Unpublish an asset call is used to unpublish a specific version of an asset from a desired environment.
- unpublish(JSONObject) - Method in class com.contentstack.cms.stack.Entry
-
To Unpublish an entry call will unpublish an entry at once, and also, gives you the provision to unpublish an entry automatically at a later date/time.
- unpublish(Map<String, Object>, String, String, JSONObject) - Method in interface com.contentstack.cms.stack.EntryService
- unpublish(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.AssetService
- unshare(JSONObject) - Method in class com.contentstack.cms.stack.Stack
-
Unshare a stack
- unshare(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.StackService
- update(JSONObject) - Method in class com.contentstack.cms.stack.Alias
-
Assign or Update an alias
The Assign an alias request creates a new alias in a particular stack of your organization. - update(JSONObject) - Method in class com.contentstack.cms.stack.DeliveryToken
-
The Update delivery token request lets you update the details of a delivery token.
- update(JSONObject) - Method in class com.contentstack.cms.stack.Environment
-
The Update environment call will update the details of an existing publishing environment for a stack.
- update(JSONObject) - Method in class com.contentstack.cms.stack.GlobalField
-
Update a global field
- update(JSONObject) - Method in class com.contentstack.cms.stack.Label
-
The Update label call is used to update an existing label.
- update(JSONObject) - Method in class com.contentstack.cms.stack.Locale
-
The Update language call will let you update the details (such as display name) and the fallback language of an existing language of your stack.
- update(JSONObject) - Method in class com.contentstack.cms.stack.ManagementToken
-
The Update management token request lets you update the details of a management token.
- update(JSONObject) - Method in class com.contentstack.cms.stack.Release
-
To Update a Release call allows you to update the details of a Release, i.e., the ‘name’ and ‘description’.
- update(JSONObject) - Method in class com.contentstack.cms.stack.ReleaseItem
-
The Update Release items to their latest versions request let you update all the release items (entries and assets) to their latest versions before deployment
- update(JSONObject) - Method in class com.contentstack.cms.stack.Roles
-
The Update role request lets you modify an existing role of your stack.
- update(JSONObject) - Method in class com.contentstack.cms.stack.Stack
-
Update Stack
The Update stack call lets you update the name and description of an existing stack. - update(JSONObject) - Method in class com.contentstack.cms.stack.Workflow
-
The Add or Update Workflow request allows you to add a workflow stage or update the details of the existing stages of a workflow.
- update(JSONObject) - Method in class com.contentstack.cms.stack.Folder
-
The Update or move folder request can be used either to update the details of a folder or set the parent folder if you want to move a folder under another folder.
- update(String, Map<String, Object>, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.ContentTypeService
- update(Map<String, Object>, String, String, JSONObject, Map<String, Object>) - Method in interface com.contentstack.cms.stack.EntryService
- update(Map<String, Object>, String, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.ExtensionsService
- update(Map<String, Object>, String, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.LocaleService
- update(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.EnvironmentService
- update(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.GlobalFieldService
- update(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.LabelService
- update(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.ReleaseService
- update(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.WebhookService
- update(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.WorkflowService
- update(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.AliasService
- update(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.StackService
- update(Map<String, String>, JSONObject) - Method in interface com.contentstack.cms.user.UserService
- update(JSONObject) - Method in class com.contentstack.cms.stack.ContentType
-
Update Content Type
- update(JSONObject) - Method in class com.contentstack.cms.stack.Entry
-
The Update an entry call lets you update the content of an existing entry.
- update(JSONObject) - Method in class com.contentstack.cms.stack.Extensions
- update(JSONObject) - Method in class com.contentstack.cms.stack.Webhook
-
The Update webhook request allows you to update the details of an existing webhook in the stack.
- update(JSONObject) - Method in class com.contentstack.cms.user.User
-
The Update User API Request updates the details of an existing user account.
- updatedAt - Variable in class com.contentstack.cms.models.UserModel
- updateDeliveryToken(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.TokenService
- updateDetails(Map<String, Object>, String, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.AssetService
- updateDetails(JSONObject) - Method in class com.contentstack.cms.stack.Asset
-
The Update asset revision call upgrades a specified version of an asset as the latest version of that asset.
- updateFallback(JSONObject) - Method in class com.contentstack.cms.stack.Locale
-
The Update fallback language request allows you to update the fallback language for an existing language of your stack.
- updateFallback(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.LocaleService
- updateFolder(Map<String, Object>, String, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.AssetService
- updateItems(Map<String, Object>, String, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.ReleaseService
- updateManagementToken(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.TokenService
- updatePublishRule(String, JSONObject) - Method in class com.contentstack.cms.stack.Workflow
-
Add or Update Publish Rules request allows you to add a publishing rule or update the details of the existing publishing rules of a workflow.
- updatePublishRules(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.WorkflowService
- updateRole(Map<String, Object>, String, JSONObject) - Method in interface com.contentstack.cms.stack.RolesService
- updateSetting(JSONObject) - Method in class com.contentstack.cms.stack.Stack
-
Add/Update Stack Settings
- updateSetting(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.StackService
- updateUserRoles(Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.StackService
- updateWorkflowStage(Map<String, Object>, String, String, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.WorkflowService
- uploadAsset(String, String) - Method in class com.contentstack.cms.stack.Asset
-
The Upload asset request uploads an asset file to your stack.
- uploadAsset(Map<String, Object>, MultipartBody.Part, RequestBody, Map<String, Object>) - Method in interface com.contentstack.cms.stack.AssetService
- uploadCustomField(Map<String, Object>, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.ExtensionsService
- uploadCustomField(Map<String, Object>, Map<String, RequestBody>, Map<String, Object>) - Method in interface com.contentstack.cms.stack.ExtensionsService
- uploadCustomField(Map<String, RequestBody>) - Method in class com.contentstack.cms.stack.Extensions
-
The Upload a custom field request is used to upload a custom field to Contentstack.
- uploadCustomField(JSONObject) - Method in class com.contentstack.cms.stack.Extensions
-
The Upload a custom field request is used to upload a custom field to Contentstack.
- user - Variable in class com.contentstack.cms.Contentstack
- user - Variable in class com.contentstack.cms.models.LoginDetails
- user - Variable in class com.contentstack.cms.models.UserDetail
- user() - Method in class com.contentstack.cms.Contentstack
-
All accounts registered with Contentstack are known as Users.
- User - Class in com.contentstack.cms.user
-
All accounts registered with Contentstack are known as Users.
- User(Retrofit) - Constructor for class com.contentstack.cms.user.User
- USER_AGENT - Static variable in class com.contentstack.cms.core.Util
- USER_ALREADY_LOGGED_IN - Static variable in class com.contentstack.cms.core.Util
- UserDetail - Class in com.contentstack.cms.models
- UserDetail() - Constructor for class com.contentstack.cms.models.UserDetail
- UserModel - Class in com.contentstack.cms.models
- UserModel() - Constructor for class com.contentstack.cms.models.UserModel
- username - Variable in class com.contentstack.cms.models.UserModel
- UserService - Interface in com.contentstack.cms.user
- Util - Class in com.contentstack.cms.core
-
The utility class that contains utility common functions
V
- version - Variable in class com.contentstack.cms.Contentstack
- VERSION - Static variable in class com.contentstack.cms.core.Util
- versionName(int, JSONObject) - Method in class com.contentstack.cms.stack.Entry
-
Version naming allows you to assign a name to a version of an entry for easy identification.
- versionName(Map<String, Object>, String, String, String, JSONObject) - Method in interface com.contentstack.cms.stack.EntryService
- visibilityRule(String, Map<String, Object>, Map<String, Object>, JSONObject) - Method in interface com.contentstack.cms.stack.ContentTypeService
W
- warning(String) - Method in class com.contentstack.cms.core.CMALogger
- webhook() - Method in class com.contentstack.cms.stack.Stack
-
A webhook is a mechanism that sends real-time information to any third-party app or service to keep your application in sync with your Contentstack account.
- webhook(String) - Method in class com.contentstack.cms.stack.Stack
-
A webhook is a mechanism that sends real-time information to any third-party app or service to keep your application in sync with your Contentstack account.
- Webhook - Class in com.contentstack.cms.stack
-
A webhook is a mechanism that sends real-time information to any third-party app or service to keep your application in sync with your Contentstack account.
- Webhook(Retrofit) - Constructor for class com.contentstack.cms.stack.Webhook
- Webhook(Retrofit, String) - Constructor for class com.contentstack.cms.stack.Webhook
- WebhookService - Interface in com.contentstack.cms.stack
- workflow() - Method in class com.contentstack.cms.stack.Stack
-
Workflow is a tool that allows you to streamline the process of content creation and publishing, and lets you manage the content lifecycle of your project smoothly.
- workflow(String) - Method in class com.contentstack.cms.stack.Stack
-
Workflow is a tool that allows you to streamline the process of content creation and publishing, and lets you manage the content lifecycle of your project smoothly.
- Workflow - Class in com.contentstack.cms.stack
-
Workflow is a tool that allows you to streamline the process of content creation and publishing, and lets you manage the content lifecycle of your project smoothly.
- Workflow(Retrofit) - Constructor for class com.contentstack.cms.stack.Workflow
- Workflow(Retrofit, String) - Constructor for class com.contentstack.cms.stack.Workflow
- WorkflowService - Interface in com.contentstack.cms.stack
X
- X_USER_AGENT - Static variable in class com.contentstack.cms.core.Util
All Classes|All Packages