StreamLink

open class StreamLink : DataValue

Represents a link to the value of a media entity resource or a stream-typed property.

See also

EntityType.isMedia, Property.isStream.

  • Which entity set does this stream link belong to?

    Declaration

    Swift

    final public var entitySet: EntitySet?

  • Media type if known, otherwise nil.

    See also

    Internet media type.

    Declaration

    Swift

    final public var mediaType: String?

  • Server-generated entity tag for this entity. If non-null, it is used for conflict detection during DataService.uploadMedia and DataService.uploadStream calls.

    Declaration

    Swift

    final public var entityTag: String?

  • The edit link for this value, preferably relative to the service root URL. If a stream does not have an explicit edit link, then writers should use the valuePath, or if that is not set, then a canonical URL (refer to the OData specification).

    Declaration

    Swift

    final public var editLink: String?

  • The read link for this value, preferably relative to the service root URL. If a stream does not have an explicit read link, then readers should use the valuePath, or if that is not set, then a canonical URL (refer to the OData specification).

    Declaration

    Swift

    final public var readLink: String?

  • If the stream content has been (or is being) deleted, then true, otherwise false.

    Declaration

    Swift

    final public var isDeleted: Bool

  • If the stream content is available offline, then true, otherwise false.

    Declaration

    Swift

    final public var isOffline: Bool

  • Default initializer.

    Declaration

    Swift

    override public init()

  • Declaration

    Swift

    open func copyLink() -> StreamLink

    Return Value

    A copy of this stream link.

  • Data type with a DataType.code of DataType.STREAM_LINK.

    Declaration

    Swift

    override open var dataType: DataType { get }

  • Declaration

    Swift

    open class func equal(a: StreamLink?, b: StreamLink?) -> Bool

    Parameters

    a

    First stream link.
    b

    Second stream link.

    Return Value

    true if two stream links have equal read/edit links.

  • Inline binary content if known, otherwise nil.

    Declaration

    Swift

    open var inlineData: Data? { get set }

  • Inline string content if known, otherwise nil.

    Declaration

    Swift

    open var inlineText: String? { get set }

  • Which structure type does this stream link belong to?

    Declaration

    Swift

    public final var owningType: StructureType { get set }

  • Which stream property does this stream link belong to?

    Declaration

    Swift

    public final var streamProperty: StreamProperty { get set }

  • Convert this data value to a string. If the dataType is defined by XML Schema Part 2: Datatypes, then the corresponding lexical format is used. JSON format is used for structured values (arrays and objects).

    Declaration

    Swift

    override open func toString() -> String

    Return Value

    Lexical representation of this data value.

  • Data type code of the wrapped value, equivalent to dataType.code.

    Declaration

    Swift

    override open var typeCode: Int { get }

  • The canonical path of this value relative to the parent entity URL.

    Declaration

    Swift

    @inline(__always)
public final var valuePath: String? { get set }