ContactsApi Class Reference


                    
                    
                    -add:error:

Add a new Contact to the account’s list of Contacts

Objective-C

- (void)add:(id)contact error:(NSError *_Nullable *_Nullable)error;

Swift

func add(_ contact: Any!, error: NSErrorPointer)

`contact`	The new contact to add, usually returned from a Contact search
`error`	A reference to an error pointer that will be set in the case of an error


                    
                    
                    -get:error:

Get a Contact by address from list of existing Contacts

Objective-C

- (id)get:(nonnull NSString *)address
    error:(NSError *_Nullable *_Nullable)error;

Swift

func get(_ address: String) throws -> Any

`address`	The address of the Contact to retrieve
`error`	A reference to an error pointer that will be set in the case of an error

The Contact object corresponding to the address


                    
                    
                    -list:

List all existing account Contacts

Objective-C

- (id)list:(NSError *_Nullable *_Nullable)error;

Swift

func list() throws -> Any


                                error

A reference to an error pointer that will be set in the case of an error

An object containing a list of all account contacts


                    
                    
                    -remove:error:

Remove a Contact from the account by address

Objective-C

- (void)remove:(nonnull NSString *)address
         error:(NSError *_Nullable *_Nullable)error;

Swift

func remove(_ address: String, error: NSErrorPointer)

`address`	The address of the contact to remove
`error`	A reference to an error pointer that will be set in the case of an error


                    
                    
                    -threads:error:

List all threads a particular contact and the local node account participate in

Objective-C

- (id)threads:(nonnull NSString *)address
        error:(NSError *_Nullable *_Nullable)error;

Swift

func threads(_ address: String) throws -> Any

`address`	The contact address to find threads for
`error`	A reference to an error pointer that will be set in the case of an error

An object containing a list of all threads the contact and the local node account participate in


                    
                    
                    -search:options:error:

Search for Textile Contacts across the entire network

Objective-C

- (id)search:(id)query
     options:(id)options
       error:(NSError *_Nullable *_Nullable)error;

Swift

func search(_ query: Any!, options: Any!) throws -> Any

`query`	A query object describing the search to execute
`options`	A query options object to control the behavior of the search
`error`	A reference to an error pointer that will be set in the case of an error

A handle that can be used to cancel the search