Aspose::Email::Clients::Graph::GraphClient Class Reference

Provides access to MS Exchange Server (Office365) by using REST API. More...

Inherits IDisposable.

Public Member Functions

System::SharedPtr< Aspose::Email::Common::Buffers::ArrayPool< uint8_t > > get_ByteArrayPool () const
 Gets byte array pool More...
 
virtual System::SharedPtr< System::Net::IWebProxy > get_Proxy ()
 Gets data to proxy access to Exchange server. More...
 
virtual void set_Proxy (System::SharedPtr< System::Net::IWebProxy > value)
 Sets data to proxy access to Exchange server. More...
 
virtual int32_t get_Timeout ()
 Gets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds). More...
 
virtual void set_Timeout (int32_t value)
 Sets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds). More...
 
virtual System::SharedPtr< IMultipleServicesTokenProviderget_MultipleServicesTokenProvider ()
 Gets an object allows to retrieve OAuth access token. More...
 
virtual void set_MultipleServicesTokenProvider (System::SharedPtr< IMultipleServicesTokenProvider > value)
 Sets an object allows to retrieve OAuth access token. More...
 
virtual System::SharedPtr< ITokenProviderget_TokenProvider ()
 Gets an object allows to retrieve OAuth access token. More...
 
virtual void set_TokenProvider (System::SharedPtr< ITokenProvider > value)
 Sets an object allows to retrieve OAuth access token. More...
 
virtual System::String get_TenantId ()
 Gets tenant identifier More...
 
virtual void set_TenantId (System::String value)
 Sets tenant identifier More...
 
virtual System::String get_ResourceId ()
 Gets resource id. For instance for users it may be user principal name (UPN) or user id More...
 
virtual void set_ResourceId (System::String value)
 Sets resource id. For instance for users it may be user principal name (UPN) or user id More...
 
virtual ResourceType get_Resource ()
 Gets resource type. More...
 
virtual void set_Resource (ResourceType value)
 Sets resource type. More...
 
System::SharedPtr< IHttpWebRequestCreate > get_WebRequestCreate ()
 
void set_WebRequestCreate (System::SharedPtr< IHttpWebRequestCreate > value)
 
 GraphClient (System::SharedPtr< IMultipleServicesTokenProvider > tokenProvider, System::String tenantId)
 Initializes a new instance of the GraphClient class. More...
 
 GraphClient (System::SharedPtr< ITokenProvider > tokenProvider, System::String tenantId)
 Initializes a new instance of the GraphClient class. More...
 
void Dispose () override
 Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. More...
 

Static Public Member Functions

static System::SharedPtr< IGraphClientGetClient (System::SharedPtr< IMultipleServicesTokenProvider > tokenProvider, System::String tenantId)
 Initializes a new instance of the GraphClient based class More...
 
static System::SharedPtr< IGraphClientGetClient (System::SharedPtr< ITokenProvider > tokenProvider, System::String tenantId)
 Initializes a new instance of the GraphClient based class More...
 

Static Public Attributes

static const int32_t DEFAULT_TIMEOUT
 The default value is 100,000 milliseconds (100 seconds). More...
 

Friends

class Aspose::Email::Clients::Graph::GraphClientExtensions
 
class Aspose::Email::Clients::Graph::V1::Commands::BaseGraphCommand
 
class Aspose::Email::Clients::Graph::GraphClientV1
 

Detailed Description

Provides access to MS Exchange Server (Office365) by using REST API.

Constructor & Destructor Documentation

◆ GraphClient() [1/2]

Aspose::Email::Clients::Graph::GraphClient::GraphClient ( System::SharedPtr< IMultipleServicesTokenProvider tokenProvider,
System::String  tenantId 
)

Initializes a new instance of the GraphClient class.

Parameters
tokenProviderToken provider allows to retrieve OAuth access token
tenantIdA tenant is representation of an organization. It's a dedicated instance of Azure AD that an organization or app developer receives when the organization or app developer, creates a relationship with Microsoft like signing up for Azure, Microsoft Intune, or Microsoft 365.

◆ GraphClient() [2/2]

Aspose::Email::Clients::Graph::GraphClient::GraphClient ( System::SharedPtr< ITokenProvider tokenProvider,
System::String  tenantId 
)

Initializes a new instance of the GraphClient class.

Parameters
tokenProviderToken provider allows to retrieve OAuth access token
tenantIdA tenant is representation of an organization. It's a dedicated instance of Azure AD that an organization or app developer receives when the organization or app developer, creates a relationship with Microsoft like signing up for Azure, Microsoft Intune, or Microsoft 365.

Member Function Documentation

◆ Dispose()

void Aspose::Email::Clients::Graph::GraphClient::Dispose ( )
override

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

◆ get_ByteArrayPool()

System::SharedPtr<Aspose::Email::Common::Buffers::ArrayPool<uint8_t> > Aspose::Email::Clients::Graph::GraphClient::get_ByteArrayPool ( ) const

Gets byte array pool

◆ get_MultipleServicesTokenProvider()

virtual System::SharedPtr<IMultipleServicesTokenProvider> Aspose::Email::Clients::Graph::GraphClient::get_MultipleServicesTokenProvider ( )
virtual

Gets an object allows to retrieve OAuth access token.

◆ get_Proxy()

virtual System::SharedPtr<System::Net::IWebProxy> Aspose::Email::Clients::Graph::GraphClient::get_Proxy ( )
virtual

Gets data to proxy access to Exchange server.

◆ get_Resource()

virtual ResourceType Aspose::Email::Clients::Graph::GraphClient::get_Resource ( )
virtual

Gets resource type.

◆ get_ResourceId()

virtual System::String Aspose::Email::Clients::Graph::GraphClient::get_ResourceId ( )
virtual

Gets resource id. For instance for users it may be user principal name (UPN) or user id

◆ get_TenantId()

virtual System::String Aspose::Email::Clients::Graph::GraphClient::get_TenantId ( )
virtual

Gets tenant identifier

◆ get_Timeout()

virtual int32_t Aspose::Email::Clients::Graph::GraphClient::get_Timeout ( )
virtual

Gets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds).

◆ get_TokenProvider()

virtual System::SharedPtr<ITokenProvider> Aspose::Email::Clients::Graph::GraphClient::get_TokenProvider ( )
virtual

Gets an object allows to retrieve OAuth access token.

◆ get_WebRequestCreate()

System::SharedPtr<IHttpWebRequestCreate> Aspose::Email::Clients::Graph::GraphClient::get_WebRequestCreate ( )

◆ GetClient() [1/2]

static System::SharedPtr<IGraphClient> Aspose::Email::Clients::Graph::GraphClient::GetClient ( System::SharedPtr< IMultipleServicesTokenProvider tokenProvider,
System::String  tenantId 
)
static

Initializes a new instance of the GraphClient based class

Parameters
tokenProviderToken provider allows to retrieve OAuth access token
tenantIdA tenant is representation of an organization. It's a dedicated instance of Azure AD that an organization or app developer receives when the organization or app developer, creates a relationship with Microsoft like signing up for Azure, Microsoft Intune, or Microsoft 365.
Returns
Returns IGraphClient object

◆ GetClient() [2/2]

static System::SharedPtr<IGraphClient> Aspose::Email::Clients::Graph::GraphClient::GetClient ( System::SharedPtr< ITokenProvider tokenProvider,
System::String  tenantId 
)
static

Initializes a new instance of the GraphClient based class

Parameters
tokenProviderToken provider allows to retrieve OAuth access token
tenantIdA tenant is representation of an organization. It's a dedicated instance of Azure AD that an organization or app developer receives when the organization or app developer, creates a relationship with Microsoft like signing up for Azure, Microsoft Intune, or Microsoft 365.
Returns
Returns IGraphClient object

◆ set_MultipleServicesTokenProvider()

virtual void Aspose::Email::Clients::Graph::GraphClient::set_MultipleServicesTokenProvider ( System::SharedPtr< IMultipleServicesTokenProvider value)
virtual

Sets an object allows to retrieve OAuth access token.

◆ set_Proxy()

virtual void Aspose::Email::Clients::Graph::GraphClient::set_Proxy ( System::SharedPtr< System::Net::IWebProxy >  value)
virtual

Sets data to proxy access to Exchange server.

◆ set_Resource()

virtual void Aspose::Email::Clients::Graph::GraphClient::set_Resource ( ResourceType  value)
virtual

Sets resource type.

◆ set_ResourceId()

virtual void Aspose::Email::Clients::Graph::GraphClient::set_ResourceId ( System::String  value)
virtual

Sets resource id. For instance for users it may be user principal name (UPN) or user id

◆ set_TenantId()

virtual void Aspose::Email::Clients::Graph::GraphClient::set_TenantId ( System::String  value)
virtual

Sets tenant identifier

◆ set_Timeout()

virtual void Aspose::Email::Clients::Graph::GraphClient::set_Timeout ( int32_t  value)
virtual

Sets the number of milliseconds to wait before the operation times out. The default value is 100,000 milliseconds (100 seconds).

◆ set_TokenProvider()

virtual void Aspose::Email::Clients::Graph::GraphClient::set_TokenProvider ( System::SharedPtr< ITokenProvider value)
virtual

Sets an object allows to retrieve OAuth access token.

◆ set_WebRequestCreate()

void Aspose::Email::Clients::Graph::GraphClient::set_WebRequestCreate ( System::SharedPtr< IHttpWebRequestCreate >  value)

Friends And Related Function Documentation

◆ Aspose::Email::Clients::Graph::GraphClientExtensions

friend class Aspose::Email::Clients::Graph::GraphClientExtensions
friend

◆ Aspose::Email::Clients::Graph::GraphClientV1

friend class Aspose::Email::Clients::Graph::GraphClientV1
friend

◆ Aspose::Email::Clients::Graph::V1::Commands::BaseGraphCommand

friend class Aspose::Email::Clients::Graph::V1::Commands::BaseGraphCommand
friend

Member Data Documentation

◆ DEFAULT_TIMEOUT

const int32_t Aspose::Email::Clients::Graph::GraphClient::DEFAULT_TIMEOUT
static

The default value is 100,000 milliseconds (100 seconds).