Blog Studio Go to console

FirebaseFirestore Framework Reference

PipelineResult

public struct PipelineResult : @unchecked Sendable

Undocumented

  • ref

    The reference of the document, if the query returns the __name__ field.

    Declaration

    Swift

    public let ref: DocumentReference?

  • id

    The ID of the document for which this PipelineResult contains data, if available.

    Declaration

    Swift

    public let id: String?

  • The time the document was created, if available.

    Declaration

    Swift

    public let createTime: Timestamp?

  • The time the document was last updated when the snapshot was generated.

    Declaration

    Swift

    public let updateTime: Timestamp?

  • Retrieves all fields in the result as a dictionary.

    Declaration

    Swift

    public let data: [String : Sendable?]

  • Retrieves the field specified by fieldPath.

    Declaration

    Swift

    public func get(_ fieldName: String) -> Sendable?

    Parameters

    fieldPath

    The field path (e.g., “foo” or “foo.bar”).

    Return Value

    The data at the specified field location or nil if no such field exists.

  • Retrieves the field specified by fieldPath.

    Declaration

    Swift

    public func get(_ fieldPath: FieldPath) -> Sendable?

    Parameters

    fieldPath

    The field path (e.g., “foo” or “foo.bar”).

    Return Value

    The data at the specified field location or nil if no such field exists.

  • Retrieves the field specified by fieldPath.

    Declaration

    Swift

    public func get(_ field: Field) -> Sendable?

    Parameters

    fieldPath

    The field path (e.g., “foo” or “foo.bar”).

    Return Value

    The data at the specified field location or nil if no such field exists.