dns.rst

≡ dns API

• Permissions
• Functions
• Types

dns API

Asynchronous DNS API

.. rst-class:: api-main-section

Permissions

.. api-member::
   :name: :permission:`dns`

.. rst-class:: api-permission-info

Note

The permission dns is required to use messenger.dns.*.

.. rst-class:: api-main-section

Functions

resolve(hostname, [flags])

.. api-section-annotation-hack::

Resolves a hostname to a DNS record.

.. api-header::
   :label: Parameters


   .. api-member::
      :name: ``hostname``
      :type: (string)


   .. api-member::
      :name: [``flags``]
      :type: (:ref:`dns.ResolveFlags`, optional)

.. api-header::
   :label: Required permissions

   - :permission:`dns`

.. rst-class:: api-main-section

Types

DNSRecord

.. api-section-annotation-hack::

An object encapsulating a DNS Record.

.. api-header::
   :label: object


   .. api-member::
      :name: ``addresses``
      :type: (array of string)


   .. api-member::
      :name: ``isTRR``
      :type: (string)

      Record retreived with TRR.


   .. api-member::
      :name: [``canonicalName``]
      :type: (string, optional)

      The canonical hostname for this record.  this value is empty if the record was not fetched with the 'canonical_name' flag.

ResolveFlags

.. api-section-annotation-hack::

.. api-header::
   :label: array of `string`


   .. container:: api-member-node

      .. container:: api-member-description-only

         Supported values:

         .. api-member::
            :name: :value:`allow_name_collisions`

         .. api-member::
            :name: :value:`bypass_cache`

         .. api-member::
            :name: :value:`canonical_name`

         .. api-member::
            :name: :value:`disable_ipv4`

         .. api-member::
            :name: :value:`disable_ipv6`

         .. api-member::
            :name: :value:`disable_trr`

         .. api-member::
            :name: :value:`offline`

         .. api-member::
            :name: :value:`priority_low`

         .. api-member::
            :name: :value:`priority_medium`

         .. api-member::
            :name: :value:`speculate`