ContentfulOptions.cs
1.96 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Contentful.Core.Errors;
namespace Contentful.Core.Configuration
{
/// <summary>
/// Represents a set of options to configure a <see cref="ContentfulClient"/>.
/// </summary>
public class ContentfulOptions
{
/// <summary>
/// The api key used when communicating with the Contentful delivery API.
/// </summary>
public string DeliveryApiKey { get; set; }
/// <summary>
/// The api key used when communicating with the Contentful preview API.
/// <remarks>
/// To use the preview API the <see cref="UsePreviewApi"/> property must be set to true.
/// </remarks>
/// </summary>
public string PreviewApiKey { get; set; }
/// <summary>
/// The api key used when communicating with the Contentful management API.
/// </summary>
public string ManagementApiKey { get; set; }
/// <summary>
/// The ID of the space that you wish to get or manipulate content for.
/// </summary>
public string SpaceId { get; set; }
/// <summary>
/// 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 <see cref="DeliveryApiKey"/>.
/// </summary>
public bool UsePreviewApi { get; set; }
/// <summary>
/// If set the client will evaluate the class to serialize into and only serialize the parts that are part of the class structure.
/// </summary>
public bool ResolveEntriesSelectively { get; set; }
/// <summary>
/// Sets the default number of times to retry after hitting a <see cref="Contentful.Core.Errors.ContentfulRateLimitException"/>.
/// 0 means that no retries will be made. Maximum is 10.
/// </summary>
public int MaxNumberOfRateLimitRetries { get; set; }
}
}