Skip to content
Snippets Groups Projects
Commit 7d19bb67 authored by Dariusz Rybicki's avatar Dariusz Rybicki
Browse files

Add XXMessengerClient quick start documentation

parent ada8d82a
No related branches found
No related tags found
2 merge requests!102Release 1.0.0,!33XXMessengerClient
# XXMessengerClient
`XXMessengerClient` is a client wrapper library for use in xx-messenger application.
## 🛠 Instantiate messenger
Example:
```swift
// setup environment:
var environment: MessengerEnvironment = .live()
// change cMix NDF environment if needed:
environment.ndfEnvironment = ...
// use alternative user-discovery if needed:
environment.udAddress = ...
environment.udCert = ...
environment.udContact = ...
// instantiate messenger:
let messenger: Messenger = .live(environment)
```
## 🚀 Start messenger
Example:
```
func start(messenger: Messenger) throws {
// check if messenger is loaded:
if messenger.isLoaded() == false {
// check if messenger is created and stored on disk:
if messenger.isCreated() == false {
// create new messenger and store it on disk:
try messenger.create()
}
// load messenger stored on disk:
try messenger.load()
}
// check if messenger is connected:
if messenger.isConnected() == false {
// start end-to-end connection:
try messenger.connect()
}
// check if messenger is logged in with user-discovery:
if messenger.isLoggedIn() == false {
// check if messenger is registered with user-discovery:
if try messenger.isRegistered() == false {
// register new user with user-discovery:
try messenger.register(username: "new-username")
} else {
// login previously registered user with user-discovery:
try messenger.logIn()
}
}
}
```
\ No newline at end of file
......@@ -13,6 +13,8 @@ Also you can checkout included example iOS application.
You can find full documentation with step by step guide [here](https://xxdk-dev.xx.network/mobile%20docs/ios-sdk)
- [XXMessengerClient](Docs/XXMessengerClient.md)
## 🚀 Quick Start
Add `XXClient` library as a dependency to your project using Swift Package Manager.
......
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