Show / Hide Table of Contents

Class ContentfulOptions

Represents a set of options to configure a ContentfulClient.

Inheritance
System.Object
ContentfulOptions
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace:Contentful.Core.Configuration
Assembly:cs.temp.dll.dll
Syntax
public class ContentfulOptions

Properties

DeliveryApiKey

The api key used when communicating with the Contentful delivery API.

Declaration
public string DeliveryApiKey { get; set; }
Property Value
Type Description
System.String

Environment

Gets or sets the space environment to use with this client.

Declaration
public string Environment { get; set; }
Property Value
Type Description
System.String

ManagementApiKey

The api key used when communicating with the Contentful management API.

Declaration
public string ManagementApiKey { get; set; }
Property Value
Type Description
System.String

MaxNumberOfRateLimitRetries

Sets the default number of times to retry after hitting a ContentfulRateLimitException. 0 means that no retries will be made. Maximum is 10.

Declaration
public int MaxNumberOfRateLimitRetries { get; set; }
Property Value
Type Description
System.Int32

PreviewApiKey

The api key used when communicating with the Contentful preview API. To use the preview API the UsePreviewApi property must be set to true.

Declaration
public string PreviewApiKey { get; set; }
Property Value
Type Description
System.String

ResolveEntriesSelectively

If set the client will evaluate the class to serialize into and only serialize the parts that are part of the class structure.

Declaration
public bool ResolveEntriesSelectively { get; set; }
Property Value
Type Description
System.Boolean

SpaceId

The ID of the space that you wish to get or manipulate content for.

Declaration
public string SpaceId { get; set; }
Property Value
Type Description
System.String

UsePreviewApi

Whether or not to use the Preview API for requests. If this is set to true the preview API key needs to be used for DeliveryApiKey.

Declaration
public bool UsePreviewApi { get; set; }
Property Value
Type Description
System.Boolean
Back to top Copyright © 2015-2016 Contentful
Generated by DocFX