Um objeto CollectionReference pode ser usado para adicionar documentos, obter referências de documentos e consultar documentos (usando query() ).
Assinatura:
export declare class CollectionReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query<AppModelType, DbModelType>
Estende: consulta <AppModelType, DbModelType>
Propriedades
| Propriedade | Modificadores | Tipo | Descrição |
|---|---|---|---|
| eu ia | corda | O identificador da coleção. | |
| pai | DocumentReference < DocumentData , DocumentData > | nulo | Uma referência ao DocumentReference contido se esta for uma subcoleção. Se esta não for uma subcoleção, a referência será nula. | |
| caminho | corda | Uma string que representa o caminho da coleção referenciada (relativa à raiz do banco de dados). | |
| tipo | (Não Declarado) | O tipo desta referência do Firestore. |
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| withConverter (conversor) | Aplica um conversor de dados personalizado a este CollectionReference , permitindo que você use seus próprios objetos de modelo personalizados com o Firestore. Quando você chama addDoc() com a instância CollectionReference retornada, o conversor fornecido converte entre os dados Firestore do tipo NewDbModelType e seu tipo personalizado NewAppModelType . | |
| withConverter (conversor) | Remove o conversor atual. |
CollectionReference.id
O identificador da coleção.
Assinatura:
get id(): string;
CollectionReference.parent
Uma referência ao DocumentReference contido se esta for uma subcoleção. Se esta não for uma subcoleção, a referência será nula.
Assinatura:
get parent(): DocumentReference<DocumentData, DocumentData> | null;
CollectionReference.path
Uma string que representa o caminho da coleção referenciada (relativa à raiz do banco de dados).
Assinatura:
get path(): string;
CollectionReference.type
O tipo desta referência do Firestore.
Assinatura:
readonly type = "collection";
CollectionReference.withConverter()
Aplica um conversor de dados personalizado a este CollectionReference , permitindo que você use seus próprios objetos de modelo personalizados com o Firestore. Quando você chama addDoc() com a instância CollectionReference retornada, o conversor fornecido converte entre os dados Firestore do tipo NewDbModelType e seu tipo personalizado NewAppModelType .
Assinatura:
withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): CollectionReference<NewAppModelType, NewDbModelType>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| conversor | FirestoreDataConverter <NewAppModelType, NewDbModelType> | Converte objetos de e para o Firestore. |
Retorna:
ColeçãoReferência <NewAppModelType, NewDbModelType>
Um CollectionReference que usa o conversor fornecido.
CollectionReference.withConverter()
Remove o conversor atual.
Assinatura:
withConverter(converter: null): CollectionReference<DocumentData, DocumentData>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| conversor | nulo | null remove o conversor atual. |
Retorna:
ColeçãoReferência < DocumentData , DocumentData >
Um CollectionReference<DocumentData, DocumentData> que não usa um conversor.