All Classes Interface Summary Class Summary Enum Summary Exception Summary
| Class |
Description |
| AuthorizationHeaderInterceptor |
Interceptor to add authorization header to requests
|
| CMAApiKey |
Class representing api keys created.
|
| CMAArray<T extends CMAResource> |
Represents a collection of CMA resources.
|
| CMAAsset |
Represents a resource of type Asset.
|
| CMAAsset.Fields |
Collect all fields of an asset.
|
| CMAAssetFile |
Description of a file on the asset system of Contentful.
|
| CMAAssetFile.Details |
Read only structure, detailing the content of the asset uploaded.
|
| CMAAssetFile.Details.ImageMeta |
Optional readonly structure, filled with information by Contentful, if the asset is an image.
|
| CMABulkAction |
Represents a resource of type environment.
|
| CMABulkStatus |
|
| CMACallback<T> |
Callback to be used with any of the CMAClient asynchronous methods.
|
| CMAClient |
The CMAClient is used to request information from the server.
|
| CMAClient.Builder |
Builder.
|
| CMAConstraint |
What constraints are applied to this rule?
|
| CMAConstraint.Equals |
Create an equals deciding whether the path to a field constraints a given value.
|
| CMAConstraint.FieldKeyPath |
Define a path to a field.
|
| CMAContentType |
Represents a resource of type Content Type.
|
| CMAEditorInterface |
This model can be used to control the appearance and usability of ui elements on Contentful.
|
| CMAEditorInterface.Control |
This class represents one control of the editor interface.
|
| CMAEditorInterface.Control.BuildInWidgetId |
Enum holding the build in values of a widget id.
|
| CMAEntities |
|
| CMAEntry |
Represents a resource of type Entry.
|
| CMAEnvironment |
Represents a resource of type environment.
|
| CMAEnvironmentStatus |
|
| CMAError |
|
| CMAField |
CMAField.
|
| CMAHttpException |
This class will represent known Contentful exceptions
|
| CMAHttpException.ErrorBody |
Error body potentially delivered with an error request.
|
| CMAHttpException.ErrorBody.Details |
Class to describe the error details.
|
| CMAHttpException.ErrorBody.Details.Error |
Which error did actually happen where?
|
| CMAHttpException.ErrorBody.Sys |
System properties of an error body
|
| CMALink |
This class represents a link to another resource in Contentful.
|
| CMALocale |
CMALocale.
|
| CMAMetadata |
|
| CMANotWithEnvironmentsException |
Exception defining the behavioural limits of using configured spaces and environments.
|
| CMAOrganization |
Model class representing one organization.
|
| CMAPages |
|
| CMAPayload |
This model can be used to control the appearance and usability of ui elements on Contentful.
|
| CMAPermissions |
What can the user change? The content structure? The content values? The space?
|
| CMAPersonalAccessToken |
Model storing the information about a personal access token.
|
| CMAPersonalAccessToken.Scope |
Enum holding the allowed values of scope.
|
| CMAPolicy |
What do allow or deny a role to do.
|
| CMAPreviewApiKey |
Class representing api keys created.
|
| CMAResource |
Base CMA resource.
|
| CMARichBlock |
A collection of several nodes.
|
| CMARichDocument |
The base of a rich text field, containing all the other nodes.
|
| CMARichEmbeddedLink |
This node is an inline link to a CMAEntry
|
| CMARichHeading |
Defines a headline of the text.
|
| CMARichHorizontalRule |
A node representing a division, called a horizontal rule.
|
| CMARichHyperLink |
This block represents a link to a website.
|
| CMARichListItem |
A block representing an item inside a list.
|
| CMARichMark |
How to draw a given text.
|
| CMARichMark.CMARichMarkBold |
A bold mark of a rich text.
|
| CMARichMark.CMARichMarkCode |
The text marked by this marker should be represented by Code.
|
| CMARichMark.CMARichMarkCustom |
Any custom marker for a given rich text.
|
| CMARichMark.CMARichMarkItalic |
Declares the text as being displayed in italics.
|
| CMARichMark.CMARichMarkUnderline |
Marker for making the rich text displayed as underline.
|
| CMARichNode |
A leaf node of the rich text hierarchy.
|
| CMARichOrderedList |
A list of elements, ordered by number.
|
| CMARichParagraph |
A paragraph of nodes, usually rendered together.
|
| CMARichQuote |
A block of nodes rendered as a direct quote.
|
| CMARichTable |
Rich Text table.
|
| CMARichTableCell |
Rich Text table cell.
|
| CMARichTableHeaderCell |
Rich Text table header cell.
|
| CMARichTableRow |
Rich Text table row.
|
| CMARichText |
A leaf element of the rich text node graph: Render a given text with the given markings.
|
| CMARichUnorderedList |
Representation of a block of unordered items.
|
| CMARole |
Model representing a role in Contentful.
|
| CMAScheduledAction |
Represents model for scheduled action.
|
| CMAScheduledActionStatus |
|
| CMAScheduledFor |
|
| CMASnapshot |
This model represents a snapshot of a specific resource.
|
| CMASpace |
Represents a resource of type Space.
|
| CMASpaceMembership |
Model class, exposing a space membership.
|
| CMASystem |
Record of all system properties a resource can have.
|
| CMASystemDeserializer |
|
| CMATag |
Represents a resource of type environment.
|
| CMAType |
A Contentful resource will be of one of those types.
|
| CMAUiExtension |
CMAUiExtension
|
| CMAUiExtension.Extension |
Model holding the actual information of the extension.
|
| CMAUiExtension.Extension.FieldType |
Holder of one field type this extension should be used on.
|
| CMAUiExtensionParameter |
CMAUiExtensionParameter
|
| CMAUiExtensionParameters |
CMAUiExtensionParameters
|
| CMAUiExtensionParameterType |
Enum holding the build in values of the UI extension parameter type.
|
| CMAUpload |
Class representing an uploaded file, to be used as an asset.
|
| CMAUsage |
|
| CMAUsage.DateRange |
|
| CMAUsage.UsageMetric |
|
| CMAUser |
Create a user structure.
|
| CMAVisibility |
|
| CMAWebhook |
Represents one webhook definition.
|
| CMAWebhookCall |
Model class representing an overview of a call to a webhook
|
| CMAWebhookCallDetail |
Detail of one specific call of a Webhook.
|
| CMAWebhookHeader |
A custom header for webhooks.
|
| CMAWebhookHealth |
Model class representing a health report of this webhook.
|
| CMAWebhookHealth.CMAWebhookHealthCall |
Model representing the spread of calls on this Webhook.
|
| CMAWebhookRequest |
Model class representing a request done by Contentful to a webhook.
|
| CMAWebhookResponse |
Model representing the response Contentful received from calling the Webhook.
|
| CMAWebhookTopic |
A class exporting all possible combinations of topics.
|
| CMAWebhookTransformation |
CMAWebhookTransformation
|
| Constants |
Library constants.
|
| Constants.CMAFieldType |
|
| ContentfulUserAgentHeaderInterceptor |
This header interceptor will add Contentful relevant information to the custom user agent header.
|
| ContentfulUserAgentHeaderInterceptor.Section |
A section of values used to fill out the Contentful custom HTTP header.
|
| ContentfulUserAgentHeaderInterceptor.Section.OperatingSystem |
Fixed enumeration of what operating systems we support.
|
| ContentfulUserAgentHeaderInterceptor.Section.Version |
Defines a version of this section.
|
| ContentTypeInterceptor |
Interceptor to add content type header to requests
|
| EntrySerializer |
Serialize an entry from Contentful
|
| ErrorInterceptor |
This interceptor will only be used for throwing an exception, once the server returns an error.
|
| FieldTypeAdapter |
FieldTypeAdapter.
|
| GeneratedBuildParameters |
Generated class containing the project version.
|
| HeaderInterceptor |
This class adds custom headers to all requests it intercepts.
|
| LocaleSerializer |
|
| Logger |
Custom logger interface, used for logging network traffic.
|
| Logger.Level |
Determine the level of logging
|
| LogInterceptor |
Simple interceptor to log a request and its response.
|
| MetadataSerializer |
|
| ModuleApiKeys |
Api Keys Module.
|
| ModuleAssets |
Assets Module.
|
| ModuleBulkActions |
Bulk actions Module.
|
| ModuleContentTypes |
Content Types Module.
|
| ModuleEditorInterfaces |
Editor Interfaces Module.
|
| ModuleEntries |
Entries Module.
|
| ModuleEnvironments |
Environments Module.
|
| ModuleLocales |
This module contains all the locale options available to this SDK.
|
| ModuleOrganizations |
Organizations Module.
|
| ModuleOrganizationUsage |
|
| ModulePersonalAccessTokens |
Personal Access Token Module.
|
| ModulePreviewApiKeys |
Preview Api Keys Module.
|
| ModuleRoles |
This module contains all the role options available to this SDK.
|
| ModuleScheduledActions |
Scheduled Actions Module.
|
| ModuleSpaceMemberships |
This module contains all the space membership options available to this SDK.
|
| ModuleSpaces |
Spaces Module.
|
| ModuleSpaceUsage |
|
| ModuleTags |
Content tags Module.
|
| ModuleUiExtensions |
Ui Extensions Module.
|
| ModuleUploads |
Upload Module.
|
| ModuleUsers |
Users Module.
|
| ModuleWebhooks |
This module is intended to ease communication with the webhooks module from Contentful.
|
| Platform |
An platform abstraction layer singleton providing information about the underlying system.
|
| RateLimitInterceptor |
Get informed when ever a rate limit header is encountered.
|
| RateLimits |
Class to summarize the rate limits Contentful returns.
|
| RateLimits.DefaultParser |
Default parser for rate limits, comming from HTTP Headers.
|
| RateLimits.Parser |
Interface for parsing rate limits.
|
| RateLimitsListener |
Interface to get informed about rate limits.
|
| RichTextFactory |
This factory will be used in order to create the CMARichNode-graph representation of
the Contentful data returned by a rich text - field.
|
| ServiceLocales |
Service class to define the REST interface to Contentful.
|
| ServiceOrganizationUsage |
|
| ServiceRoles |
Service class to define the REST interface to Contentful.
|
| ServiceSpaceMemberships |
Service class to define the REST interface to Contentful.
|
| ServiceSpaceUsage |
|
| SnapshotDeserializer |
This class will take a json blob and deserialize a snapshot from it.
|
| UserAgentHeaderInterceptor |
Interceptor to add user agent header to requests
|
| WebHookBodyDeserializer |
This class will take a json blob and deserialize a WebHook from it.
|