collectionQuery

collectionQuery

query on DAVCollection

const result = await collectionQuery({
  url: 'https://contacts.icloud.com/123456/carddavhome/card/',
  body: {
    'addressbook-query': {
      _attributes: getDAVAttribute([DAVNamespace.CARDDAV, DAVNamespace.DAV]),
      [`${DAVNamespaceShorthandMap[DAVNamespace.DAV]}:prop`]: formatProps(props),
      filter: {
        'prop-filter': {
          _attributes: {
            name: 'FN',
          },
        },
      },
    },
  },
  defaultNamespace: DAVNamespace.CARDDAV,
  depth: '1',
  headers: {
    authorization: 'Basic x0C9uFWd9Vz8OwS0DEAtkAlj',
  },
});

Arguments

• url required, collection url
• body required, query request body
• depth DAVDepth
• defaultNamespace defaults to DAVNamespace.DAV, default namespace for the the request body
• headers request headers

Return Value

array of DAVResponse

Behavior

send REPORT request on the target collection, parse response xml into array of DAVResponse