The OCI API. More...

#include <oci.h>

Public Member Functions
	Oci (OciProfile profile, char *timeServer="pool.ntp.org", long gmtOffsetSeconds=0, int daylightOffsetSeconds=0)
	Construct a new instance of the OCI API. More...

void	encryptAndEncode (const unsigned char *toEncrypt, unsigned char(&encoded)[500])
	Used internally to hash, sign and base64 encode the auth header to sign the request. More...

void	apiCall (OciApiRequest request, OciApiResponse &response)
	Make a call to the OCI REST API. More...

Public Attributes
WiFiClientSecure	client

const char *	HTTP_METHOD_GET = "GET"
	HTTP GET.

const char *	HTTP_METHOD_POST = "POST"
	HTTP POST.

const char *	HTTP_METHOD_PUT = "PUT"
	HTTP PUT.

const char *	HTTP_METHOD_PATCH = "PATCH"
	HTTP PATCH.

const char *	HTTP_METHOD_DELETE = "DELETE"
	HTTP DELETE.

OciProfile	ociProfile
	The OciProfile to use.

char *	ntpServer = "pool.ntp.org"
	The ntpServer.

long	gmtOffset = 0
	The offset from GMT to use for retrieving time. You shouldn't change this - requests should be signed with time at GMT.

int	daylightOffset = 0
	The daylight savings offset. Should not change this either.

Detailed Description

The OCI API.

Constructor & Destructor Documentation

inline

Construct a new instance of the OCI API.

Parameters

profile	A configured OciProfile to be used to sign API calls
timeServer	The NTP Server to be used to obtain the current time. Normally it should be left as default.
gmtOffsetSeconds	The offset in seconds from GMT for the time object. Leave this as 0, API calls must be signed with the current time in GMT
daylightOffsetSeconds	Offset in seconds for DST. Leave as zero.

inline

Make a call to the OCI REST API.

Parameters

[in]	request	The API request
[out]	response	The API response

inline

Used internally to hash, sign and base64 encode the auth header to sign the request.

Parameters

[in]	toEncrypt	toEncrypt the value to encrypt
[out]	encoded	&encoded the hashed/signed/encoded output

The documentation for this class was generated from the following file: