ConnectorClient Interface

Package:
com.microsoft.bot.connector
Maven Artifact:
com.microsoft.bot:bot-connector:4.14.3

Implements

java.lang.AutoCloseable

public interface ConnectorClient
extends java.lang.AutoCloseable

The interface for ConnectorClient class.

Method Summary

Modifier and Type Method and Description
abstract java.lang.String baseUrl()

Returns the base url for this ConnectorClient.
abstract ServiceClientCredentials credentials()

Returns the credentials in use.
abstract java.lang.String getAcceptLanguage()

Gets the preferred language for the response..
abstract Attachments getAttachments()

Gets the Attachments object to access its operations.
abstract Conversations getConversations()

Gets the Conversations object to access its operations.
abstract boolean getGenerateClientRequestId()

When set to true a unique x-ms-client-request-id value is generated and included in each request.
abstract int getLongRunningOperationRetryTimeout()

Gets the retry timeout in seconds for Long Running Operations.
abstract RestClient getRestClient()

Gets the REST client.
abstract java.lang.String getUserAgent()

Gets the User-Agent header for the client.
abstract void setAcceptLanguage(String acceptLanguage)

Sets the preferred language for the response..
abstract void setGenerateClientRequestId(boolean generateClientRequestId)

When set to true a unique x-ms-client-request-id value is generated and included in each request.
abstract void setLongRunningOperationRetryTimeout(int timeout)

Sets the retry timeout in seconds for Long Running Operations.

Method Details

baseUrl

public abstract String baseUrl()

Returns the base url for this ConnectorClient.

Returns:

The base url.

credentials

public abstract ServiceClientCredentials credentials()

Returns the credentials in use.

Returns:

The ServiceClientCredentials in use.

getAcceptLanguage

public abstract String getAcceptLanguage()

Gets the preferred language for the response..

Returns:

the acceptLanguage value.

getAttachments

public abstract Attachments getAttachments()

Gets the Attachments object to access its operations.

Returns:

the Attachments object.

getConversations

public abstract Conversations getConversations()

Gets the Conversations object to access its operations.

Returns:

the Conversations object.

getGenerateClientRequestId

public abstract boolean getGenerateClientRequestId()

When set to true a unique x-ms-client-request-id value is generated and included in each request. is true.

Returns:

the generateClientRequestId value.

getLongRunningOperationRetryTimeout

public abstract int getLongRunningOperationRetryTimeout()

Gets the retry timeout in seconds for Long Running Operations. Default value is 30..

Returns:

the timeout value.

getRestClient

public abstract RestClient getRestClient()

Gets the REST client.

Returns:

the RestClient object.

getUserAgent

public abstract String getUserAgent()

Gets the User-Agent header for the client.

Returns:

the user agent string.

setAcceptLanguage

public abstract void setAcceptLanguage(String acceptLanguage)

Sets the preferred language for the response..

Parameters:

acceptLanguage - the acceptLanguage value.

setGenerateClientRequestId

public abstract void setGenerateClientRequestId(boolean generateClientRequestId)

When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Parameters:

generateClientRequestId - the generateClientRequestId value.

setLongRunningOperationRetryTimeout

public abstract void setLongRunningOperationRetryTimeout(int timeout)

Sets the retry timeout in seconds for Long Running Operations. Default value is 30.

Parameters:

timeout - the longRunningOperationRetryTimeout value.

Applies to