xml/Microsoft.Azure.ServiceBus.Core/ISenderClient.xml (135 lines of code) (raw):
<Type Name="ISenderClient" FullName="Microsoft.Azure.ServiceBus.Core.ISenderClient">
<TypeSignature Language="C#" Value="public interface ISenderClient : Microsoft.Azure.ServiceBus.IClientEntity" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract ISenderClient implements class Microsoft.Azure.ServiceBus.IClientEntity" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.ServiceBus.Core.ISenderClient" />
<TypeSignature Language="VB.NET" Value="Public Interface ISenderClient
Implements IClientEntity" />
<TypeSignature Language="F#" Value="type ISenderClient = interface
 interface IClientEntity" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.1.3.0</AssemblyVersion>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Azure.ServiceBus.IClientEntity</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Interface that defines common send functionality between different clients.
</summary>
<remarks>To be added.</remarks>
<altmember cref="T:Microsoft.Azure.ServiceBus.IQueueClient" />
<altmember cref="T:Microsoft.Azure.ServiceBus.ITopicClient" />
<altmember cref="T:Microsoft.Azure.ServiceBus.Core.IMessageSender" />
</Docs>
<Members>
<Member MemberName="CancelScheduledMessageAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task CancelScheduledMessageAsync (long sequenceNumber);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task CancelScheduledMessageAsync(int64 sequenceNumber) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Core.ISenderClient.CancelScheduledMessageAsync(System.Int64)" />
<MemberSignature Language="VB.NET" Value="Public Function CancelScheduledMessageAsync (sequenceNumber As Long) As Task" />
<MemberSignature Language="F#" Value="abstract member CancelScheduledMessageAsync : int64 -> System.Threading.Tasks.Task" Usage="iSenderClient.CancelScheduledMessageAsync sequenceNumber" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sequenceNumber" Type="System.Int64" />
</Parameters>
<Docs>
<param name="sequenceNumber">The <see cref="P:Microsoft.Azure.ServiceBus.Message.SystemPropertiesCollection.SequenceNumber" /> of the message to be cancelled.</param>
<summary>
Cancels a message that was scheduled.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ScheduleMessageAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<long> ScheduleMessageAsync (Microsoft.Azure.ServiceBus.Message message, DateTimeOffset scheduleEnqueueTimeUtc);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<int64> ScheduleMessageAsync(class Microsoft.Azure.ServiceBus.Message message, valuetype System.DateTimeOffset scheduleEnqueueTimeUtc) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Core.ISenderClient.ScheduleMessageAsync(Microsoft.Azure.ServiceBus.Message,System.DateTimeOffset)" />
<MemberSignature Language="VB.NET" Value="Public Function ScheduleMessageAsync (message As Message, scheduleEnqueueTimeUtc As DateTimeOffset) As Task(Of Long)" />
<MemberSignature Language="F#" Value="abstract member ScheduleMessageAsync : Microsoft.Azure.ServiceBus.Message * DateTimeOffset -> System.Threading.Tasks.Task<int64>" Usage="iSenderClient.ScheduleMessageAsync (message, scheduleEnqueueTimeUtc)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Int64></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Microsoft.Azure.ServiceBus.Message" />
<Parameter Name="scheduleEnqueueTimeUtc" Type="System.DateTimeOffset" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<param name="scheduleEnqueueTimeUtc">The UTC time that the message should be available for processing</param>
<summary>
Schedules a message to appear on Service Bus.
</summary>
<returns>The sequence number of the message that was scheduled.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SendAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SendAsync (Microsoft.Azure.ServiceBus.Message message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SendAsync(class Microsoft.Azure.ServiceBus.Message message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Core.ISenderClient.SendAsync(Microsoft.Azure.ServiceBus.Message)" />
<MemberSignature Language="VB.NET" Value="Public Function SendAsync (message As Message) As Task" />
<MemberSignature Language="F#" Value="abstract member SendAsync : Microsoft.Azure.ServiceBus.Message -> System.Threading.Tasks.Task" Usage="iSenderClient.SendAsync message" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Microsoft.Azure.ServiceBus.Message" />
</Parameters>
<Docs>
<param name="message">To be added.</param>
<summary>
Sends a message to Service Bus.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SendAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SendAsync (System.Collections.Generic.IList<Microsoft.Azure.ServiceBus.Message> messageList);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SendAsync(class System.Collections.Generic.IList`1<class Microsoft.Azure.ServiceBus.Message> messageList) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.ServiceBus.Core.ISenderClient.SendAsync(System.Collections.Generic.IList{Microsoft.Azure.ServiceBus.Message})" />
<MemberSignature Language="VB.NET" Value="Public Function SendAsync (messageList As IList(Of Message)) As Task" />
<MemberSignature Language="F#" Value="abstract member SendAsync : System.Collections.Generic.IList<Microsoft.Azure.ServiceBus.Message> -> System.Threading.Tasks.Task" Usage="iSenderClient.SendAsync messageList" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.ServiceBus</AssemblyName>
<AssemblyVersion>5.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="messageList" Type="System.Collections.Generic.IList<Microsoft.Azure.ServiceBus.Message>" />
</Parameters>
<Docs>
<param name="messageList">To be added.</param>
<summary>
Sends a list of messages to Service Bus.
When called on partitioned entities, messages meant for different partitions cannot be batched together.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>