com.aspose.email

Class GraphClient

java.lang.Object

com.aspose.email.GraphClient

All Implemented Interfaces:

IDisposable, Closeable, AutoCloseable

public abstract class GraphClient
extends Object
implements IDisposable, Closeable

Provides access to MS Graph by using REST API.

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	dispose() Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
static IGraphClient	getClient(IMultipleServicesTokenProvider tokenProvider) Initializes a new instance of the GraphClient based class
static IGraphClient	getClient(IMultipleServicesTokenProvider tokenProvider, String tenantId) Initializes a new instance of the GraphClient based class
static IGraphClient	getClient(ITokenProvider tokenProvider) Initializes a new instance of the GraphClient based class
static IGraphClient	getClient(ITokenProvider tokenProvider, String tenantId) Initializes a new instance of the GraphClient based class
String	getEndpoint() Gets or sets Microsoft Graph REST API endpoint.
IMultipleServicesTokenProvider	getMultipleServicesTokenProvider() Gets or sets an object allows to retrieve OAuth access token.
IWebProxy	getProxy() Gets or sets data to proxy access to Exchange server.
int	getResource() Gets or sets resource type.
String	getResourceId() Gets or sets resource id.
String	getTenantId() Gets or sets tenant identifier
int	getTimeout() Gets or sets the number of milliseconds to wait before the operation times out.
ITokenProvider	getTokenProvider() Gets or sets an object allows to retrieve OAuth access token.
void	setEndpoint(String value) Gets or sets Microsoft Graph REST API endpoint.
void	setMultipleServicesTokenProvider(IMultipleServicesTokenProvider value) Gets or sets an object allows to retrieve OAuth access token.
void	setProxy(IWebProxy value) Gets or sets data to proxy access to Exchange server.
void	setResource(int value) Gets or sets resource type.
void	setResourceId(String value) Gets or sets resource id.
void	setTenantId(String value) Gets or sets tenant identifier
void	setTimeout(int value) Gets or sets the number of milliseconds to wait before the operation times out.
void	setTokenProvider(ITokenProvider value) Gets or sets an object allows to retrieve OAuth access token.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getClient

public static IGraphClient getClient(IMultipleServicesTokenProvider tokenProvider,
                     String tenantId)

Initializes a new instance of the GraphClient based class

Parameters:

tokenProvider - Token provider allows to retrieve OAuth access token

tenantId - A 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

public static IGraphClient getClient(IMultipleServicesTokenProvider tokenProvider)

Initializes a new instance of the GraphClient based class

Parameters:

tokenProvider - Token provider allows to retrieve OAuth access token

Returns:

Returns IGraphClient object

getClient

public static IGraphClient getClient(ITokenProvider tokenProvider,
                     String tenantId)

Initializes a new instance of the GraphClient based class

Parameters:

tokenProvider - Token provider allows to retrieve OAuth access token

tenantId - A 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

public static IGraphClient getClient(ITokenProvider tokenProvider)

Initializes a new instance of the GraphClient based class

Parameters:

tokenProvider - Token provider allows to retrieve OAuth access token

Returns:

Returns IGraphClient object

getProxy

public IWebProxy getProxy()

Gets or sets data to proxy access to Exchange server.

setProxy

public void setProxy(IWebProxy value)

Gets or sets data to proxy access to Exchange server.

getTimeout

public int getTimeout()

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

setTimeout

public void setTimeout(int value)

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

getMultipleServicesTokenProvider

public IMultipleServicesTokenProvider getMultipleServicesTokenProvider()

Gets or sets an object allows to retrieve OAuth access token.

setMultipleServicesTokenProvider

public void setMultipleServicesTokenProvider(IMultipleServicesTokenProvider value)

Gets or sets an object allows to retrieve OAuth access token.

getTokenProvider

public ITokenProvider getTokenProvider()

Gets or sets an object allows to retrieve OAuth access token.

setTokenProvider

public void setTokenProvider(ITokenProvider value)

Gets or sets an object allows to retrieve OAuth access token.

getTenantId

public String getTenantId()

Gets or sets tenant identifier

setTenantId

public void setTenantId(String value)

Gets or sets tenant identifier

getResourceId

public String getResourceId()

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

setResourceId

public void setResourceId(String value)

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

getEndpoint

public String getEndpoint()

Gets or sets Microsoft Graph REST API endpoint. If not specified, the default is XVHK4D9KDb.get(new byte[] { (byte)0xe, (byte)0x5, (byte)0xeb, (byte)0xe9, (byte)0x67, (byte)0x27, (byte)0x52, (byte)0xfd, (byte)0x88, (byte)0x10, (byte)0x50, (byte)0x40, (byte)0x2c, (byte)0x10, (byte)0x53, (byte)0xac, (byte)0xfa, (byte)0xff, (byte)0x7a, (byte)0x72, (byte)0x9, (byte)0x17, (byte)0xeb, (byte)0xb7, (byte)0x77, (byte)0x72, (byte)0x10 }).

setEndpoint

public void setEndpoint(String value)

Gets or sets Microsoft Graph REST API endpoint. If not specified, the default is XVHK4D9KDb.get(new byte[] { (byte)0xe, (byte)0x5, (byte)0xeb, (byte)0xe9, (byte)0x67, (byte)0x27, (byte)0x52, (byte)0xfd, (byte)0x88, (byte)0x10, (byte)0x50, (byte)0x40, (byte)0x2c, (byte)0x10, (byte)0x53, (byte)0xac, (byte)0xfa, (byte)0xff, (byte)0x7a, (byte)0x72, (byte)0x9, (byte)0x17, (byte)0xeb, (byte)0xb7, (byte)0x77, (byte)0x72, (byte)0x10 }).

getResource

public int getResource()

Gets or sets resource type.

setResource

public void setResource(int value)

Gets or sets resource type.

dispose

public void dispose()

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

Specified by:

dispose in interface IDisposable

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable