taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

lookup-alias.rst (1010B)

      1 .. ts:op:: lookupAlias
      2 
      3   Look up the target URI registered for an alias at a taldir service.
      4 
      5   **Request:**
      6 
      7     The request arguments are a `TaldirLookupRequest` object.
      8 
      9   **Response:**
     10 
     11     On success, the result is a `TaldirLookupResponse` object.  The
     12     ``targetUri`` field is absent if the alias is not registered, or
     13     if the service does not support the requested alias type.
     14 
     15   **Side effects:**
     16 
     17     Queries the taldir directory service over the network; does not
     18     change wallet state.
     19 
     20   **Expected errors:**
     21 
     22     The caller can handle the following errors inline:
     23     ``WALLET_ALIAS_REGISTRATION_FAILED``.
     24 
     25 .. ts:def:: TaldirLookupRequest
     26 
     27   interface TaldirLookupRequest {
     28     // Alias to look up.
     29     alias: string;
     30 
     31     // Type of the alias.
     32     aliasType: string;
     33 
     34     // Base URL of the taldir service.
     35     taldirBaseUrl: string;
     36   }
     37 
     38 .. ts:def:: TaldirLookupResponse
     39 
     40   interface TaldirLookupResponse {
     41     // Target URI registered for the alias, if any.
     42     targetUri?: string;
     43   }