Microsoft.Bot.Connector.Attachments Class Reference

Attachments operations. More...

Inheritance diagram for Microsoft.Bot.Connector.Attachments:

Public Member Functions

 Attachments (ConnectorClient client)
 Initializes a new instance of the Attachments class. More...
 
async Task< HttpOperationResponse< object > > GetAttachmentInfoWithHttpMessagesAsync (string attachmentId, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 GetAttachmentInfo More...
 
Task< Stream > GetAttachmentStreamAsync (string attachmentId, string viewId="original")
 Get the given attachmentid view as a stream More...
 
string GetAttachmentUri (string attachmentId, string viewId="original")
 Get the URI of an attachment view More...
 
async Task< HttpOperationResponse< object > > GetAttachmentWithHttpMessagesAsync (string attachmentId, string viewId, Dictionary< string, List< string >> customHeaders=null, CancellationToken cancellationToken=default(CancellationToken))
 GetAttachment More...
 

Properties

ConnectorClient Client [get]
 Gets a reference to the ConnectorClient More...
 

Detailed Description

Attachments operations.

Definition at line 14 of file AttachmentsEx.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Connector.Attachments.Attachments ( ConnectorClient  client)
inline

Initializes a new instance of the Attachments class.

Parameters
clientReference to the service client.

Definition at line 33 of file Library/Microsoft.Bot.Connector.Shared/ConnectorAPI/Attachments.cs.

Member Function Documentation

async Task<HttpOperationResponse<object> > Microsoft.Bot.Connector.Attachments.GetAttachmentInfoWithHttpMessagesAsync ( string  attachmentId,
Dictionary< string, List< string >>  customHeaders = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

GetAttachmentInfo

Get AttachmentInfo structure describing the attachment views

Parameters
attachmentIdattachment id
customHeadersHeaders that will be added to request.
cancellationTokenThe cancellation token.

<return> A response object containing the response body and response headers. </return>

Implements Microsoft.Bot.Connector.IAttachments.

Definition at line 63 of file Library/Microsoft.Bot.Connector.Shared/ConnectorAPI/Attachments.cs.

Task<Stream> Microsoft.Bot.Connector.Attachments.GetAttachmentStreamAsync ( string  attachmentId,
string  viewId = "original" 
)
inline

Get the given attachmentid view as a stream

Parameters
attachmentIdattachmentid
viewIdview to get (default:original)
Returns
stream of attachment

Definition at line 43 of file AttachmentsEx.cs.

string Microsoft.Bot.Connector.Attachments.GetAttachmentUri ( string  attachmentId,
string  viewId = "original" 
)
inline

Get the URI of an attachment view

Parameters
attachmentId
viewIddefault is "original"
Returns
uri

Definition at line 22 of file AttachmentsEx.cs.

async Task<HttpOperationResponse<object> > Microsoft.Bot.Connector.Attachments.GetAttachmentWithHttpMessagesAsync ( string  attachmentId,
string  viewId,
Dictionary< string, List< string >>  customHeaders = null,
CancellationToken  cancellationToken = default(CancellationToken) 
)
inline

GetAttachment

Get the named view as binary content

Parameters
attachmentIdattachment id
viewIdView id from attachmentInfo
customHeadersHeaders that will be added to request.
cancellationTokenThe cancellation token.

<return> A response object containing the response body and response headers. </return>

Implements Microsoft.Bot.Connector.IAttachments.

Definition at line 261 of file Library/Microsoft.Bot.Connector.Shared/ConnectorAPI/Attachments.cs.

Property Documentation

ConnectorClient Microsoft.Bot.Connector.Attachments.Client
get

Gets a reference to the ConnectorClient

Definition at line 45 of file Library/Microsoft.Bot.Connector.Shared/ConnectorAPI/Attachments.cs.


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