Skip to content
Snippets Groups Projects
Commit 33b9c856 authored by Richard T. Carback III's avatar Richard T. Carback III
Browse files

Merge branch 'docusaurus-site' into 'master'

Add GetBackup() and ResetSession() to API Quick Reference

See merge request elixxir/xxdk-dev-docs!7
parents 02703733 4a6f73a6
No related branches found
No related tags found
1 merge request!7Add GetBackup() and ResetSession() to API Quick Reference
......@@ -267,6 +267,14 @@ func (c *Client) GetAuthenticatedChannelRequest(partner *id.ID) (contact.Contact
`GetAuthenticatedChannelRequest` returns the contact received in a request if one exists for the given userID. Returns an error if no contact is found.
### func (*Client) GetBackup
```go
func (c *Client) GetBackup() *interfaces.BackupContainer
```
`GetBackup` returns a pointer to the backup container so that the backup can be set and triggered.
### func (*Client) GetComms
```go
......@@ -471,6 +479,15 @@ func (c *Client) RequestAuthenticatedChannel(recipient, me contact.Contact,
`RequestAuthenticatedChannel` sends a request to another party to establish an authenticated channel. It will not run if the network state is not healthy. An error will be returned if a channel already exists or if a request was already received. When a confirmation occurs, the channel will be created and the callback will be called. Can be retried.
### func (*Client) ResetSession
```go
func (c *Client) ResetSession(recipient, me contact.Contact,
message string) (id.Round, error)
```
`ResetSession` resets an authenticate channel that already exists.
### func (*Client) SendCMIX
```go
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment