answered questions generate_api
authornk
Tue, 12 Nov 2019 18:24:29 +0100
branchgenerate_api
changeset 416051a48ce5f8bc
parent 4159 3c4fcf86655f
answered questions
api/basic_api.yml2
     1.1 --- a/api/basic_api.yml2	Tue Nov 12 17:07:47 2019 +0100
     1.2 +++ b/api/basic_api.yml2	Tue Nov 12 18:24:29 2019 +0100
     1.3 @@ -110,11 +110,25 @@
     1.4  
     1.5  
     1.6  struct identity {
     1.7 -    field string address doc="SMTP address or URI";
     1.8 -    field hash fpr doc="fingerprint of key being used as ID";
     1.9 -    field string user_id doc="ID for person or entity in M2M case";
    1.10 -    field string username doc="descriptive string";
    1.11 -    field ISO639_1 lang doc="two-digit language code or null bytes";
    1.12 +    field string address doc="SMTP address or URI. String with address UTF-8 encoded";
    1.13 +    field hash fpr doc="fingerprint of key being used as ID. String with fingerprint UTF-8 encoded";
    1.14 +    field string user_id 
    1.15 +    doc="""
    1.16 +        ID for person or entity in M2M case. String with user ID UTF-8 encoded
    1.17 +        user_id MIGHT be set to "pEp_own_userId" (use PEP_OWN_USERID preprocessor define)
    1.18 +        if this is own user's identity. But it is not REQUIRED to be.
    1.19 +        """;
    1.20 +    field string username doc="descriptive string. String with user name UTF-8 encoded";
    1.21 +    field comm_type comm_type doc="type of communication with this ID";
    1.22 +    field ISO639_1 lang[3] 
    1.23 +    doc="""
    1.24 +        two-digit language code or null bytes. 
    1.25 +        language of conversation ISO 639-1 ALPHA-2, last byte is 0
    1.26 +        """;
    1.27 +    field bool me doc="if this is the local user herself/himself";
    1.28 +    field unsigned int major_ver doc="highest version of pEp message received, if any";
    1.29 +    field unsigned int minor_ver doc="highest version of pEp message received, if any";
    1.30 +    field identity_flags_t flags doc="identity_flag1 | identity_flag2 | ...";
    1.31  } // struct Identity
    1.32  
    1.33  
    1.34 @@ -393,4 +407,19 @@
    1.35  
    1.36          throws cannot_find_person doc="if user_id doesn't exist";
    1.37      }
    1.38 +
    1.39 +
    1.40 +    method per_user_directory doc="returns the directory for pEp management db"
    1.41 +    {
    1.42 +        // exceptions
    1.43 +
    1.44 +        throws any doc="path to actual per user directory or NULL on failure";
    1.45 +    }
    1.46 +
    1.47 +    method per_machine_directory doc="returns the directory for pEp system db"
    1.48 +    {
    1.49 +        // exceptions
    1.50 +
    1.51 +        throws any doc="path to actual per user directory or NULL on failure";
    1.52 +    }
    1.53  }