Permalink
Fetching contributors…
Cannot retrieve contributors at this time
159 lines (157 sloc) 7.75 KB
<Type Name="Attachment" FullName="Microsoft.Azure.Documents.Attachment">
<TypeSignature Language="C#" Value="public class Attachment : Microsoft.Azure.Documents.Resource, System.Dynamic.IDynamicMetaObjectProvider" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Attachment extends Microsoft.Azure.Documents.Resource implements class System.Dynamic.IDynamicMetaObjectProvider" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Documents.Attachment" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Documents.Resource</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Dynamic.IDynamicMetaObjectProvider</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Represents a document attachment in the Azure DocumentDB database service.
</summary>
<remarks>
Each document may contain zero or more attachments containing data of arbitrary formats like images, binary or large text blobs.
The Attachment class represents the DocumentDB resource used to store information about the attachment like its location and
MIME content type. The payload itself ("Media") is referenced through the MediaLink property. The Attachment class is a DynamicObject
and can contain any custom metadata to be persisted.
Attachments can be created as managed or unmanaged. If attachments are created as managed through DocumentDB, then it is assigned a system
generated mediaLink. DocumentDB then automatically performs garbage collection on the media when parent document is deleted.
You can reuse the mediaLink property to store an external location e.g., a file share or an Azure Blob Storage URI.
DocumentDB will not perform garbage collection on mediaLinks for external locations.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Attachment ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Attachment.#ctor" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of an <see cref="T:Microsoft.Azure.Documents.Attachment" /> class for the Azure DocumentDB database service.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ContentType">
<MemberSignature Language="C#" Value="public string ContentType { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ContentType" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Attachment.ContentType" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonProperty(PropertyName="contentType")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the MIME content type of the attachment in the Azure DocumentDB database service.
</summary>
<value>
The MIME content type of the attachment.
</value>
<remarks>For example, set to "text/plain" for text files, "image/jpeg" for images.</remarks>
</Docs>
</Member>
<Member MemberName="MediaLink">
<MemberSignature Language="C#" Value="public string MediaLink { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string MediaLink" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Documents.Attachment.MediaLink" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>Newtonsoft.Json.JsonProperty(PropertyName="media")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the media link associated with the attachment content in the Azure DocumentDB database service.
</summary>
<value>
The media link associated with the attachment content.
</value>
<remarks>DocumentDB supports both managed and unmanaged attachments.</remarks>
</Docs>
</Member>
<Member MemberName="System.Dynamic.IDynamicMetaObjectProvider.GetMetaObject">
<MemberSignature Language="C#" Value="System.Dynamic.DynamicMetaObject IDynamicMetaObjectProvider.GetMetaObject (System.Linq.Expressions.Expression parameter);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Dynamic.DynamicMetaObject System.Dynamic.IDynamicMetaObjectProvider.GetMetaObject(class System.Linq.Expressions.Expression parameter) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Documents.Attachment.System#Dynamic#IDynamicMetaObjectProvider#GetMetaObject(System.Linq.Expressions.Expression)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Documents.Client</AssemblyName>
<AssemblyVersion>1.14.0.0</AssemblyVersion>
<AssemblyVersion>1.16.0.0</AssemblyVersion>
<AssemblyVersion>1.17.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.DocumentDB.Core</AssemblyName>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Dynamic.DynamicMetaObject</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="parameter" Type="System.Linq.Expressions.Expression" />
</Parameters>
<Docs>
<param name="parameter">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>