Um objeto CollectionReference pode ser usado para adicionar documentos, receber referências de documentos e consultar documentos (usando query()).
Assinatura:
export declare class CollectionReference = DocumentData, DbModelType extends DocumentData = DocumentData> extends Query, DbModelType>
Estende: Query
Propriedades
| Propriedade | Modificadores | Tipo | Descrição |
|---|---|---|---|
| id | string | O identificador da coleção. | |
| parent | DocumentReference<DocumentData, DocumentData> | nulo | Uma referência ao DocumentReference que o contém, se esta for uma subcoleção. Se não for uma subcoleção, a referência será nula. |
|
| path | string | Uma string que representa o caminho da coleção referenciada (relativo à raiz do banco de dados). | |
| type | (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 CollectionReference, permitindo que você use seus próprios objetos de modelo personalizado com o Firestore. Quando você chama addDoc() com a instância CollectionReference retornada, o conversor fornecido faz a conversão entre os dados do Firestore do tipo NewDbModelType e seu tipo personalizado NewAppModelType. |
|
| withConverter(conversor) | Remove o conversor atual. |
ColeçãoReference.id
O identificador da coleção.
Assinatura:
get id(): string;
ColeçãoReference.parent
Uma referência ao DocumentReference que o contém, se esta for uma subcoleção. Se não for uma subcoleção, a referência será nula.
Assinatura:
get parent(): DocumentReference, DocumentData> | null;
ColeçãoReference.path
Uma string que representa o caminho da coleção referenciada (relativo à raiz do banco de dados).
Assinatura:
get path(): string;
ColeçãoReference.type
O tipo desta referência do Firestore.
Assinatura:
readonly type = "collection";
ColeçãoReference.withConverter()
Aplica um conversor de dados personalizado a CollectionReference, permitindo que você use seus próprios objetos de modelo personalizado com o Firestore. Quando você chama addDoc() com a instância CollectionReference retornada, o conversor fornecido faz a conversão entre os dados do Firestore do tipo NewDbModelType e seu tipo personalizado NewAppModelType.
Assinatura:
withConverter, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter, NewDbModelType>): CollectionReference, NewDbModelType>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| converter | FirestoreDataConverter |
Converte objetos no Firestore e a partir dele. |
Retorna:
Um CollectionReference que usa o conversor fornecido.
ColeçãoReference.withConverter()
Remove o conversor atual.
Assinatura:
withConverter(converter: null): CollectionReference, DocumentData>;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| converter | null | null remove o conversor atual. |
Retorna:
CollectionReference<DocumentData, DocumentData>
Uma CollectionReference que não usa um conversor.