Manage Sudos

Create Sudos

To create a new Sudo:

Swift

do {
    let sudoInput = Sudo(title: "Mr.", 
                    firstName: "John", 
                    lastName: "Smith",
                    label: "Shopping", 
                    notes: "Used for shopping.", 
                    avatar: avatarURL)
    let sudo = try await self.sudoProfilesClient.createSudo(sudo: sudoInput)
    // Load the avatar image.
    if let avatar = sudo.avatar,
        let data = try? Data(contentsOf: avatar) {
        let image = UIImage(data: data)
    }
} catch let error {
    // Handle error. An error may be thrown if the backend is unable
    // to create the Sudo due to availability, security or entitlement issues or
    // due to unrecoverable circumstances arising from programmatic error or 
    // configuration error. For example, if the keychain access entitlement 
    // is not set up correctly, the client is not signed in,
    // or basic system resources are unavailable.   
}

Kotlin

val sudo = Sudo()
sudo.title = "Mr."
sudo.firstName = "John"
sudo.lastName = "Smith"
sudo.label = "Shopping"
sudo.notes = "Used for shopping."
sudo.avatar = avatarUri

CoroutineScope(Dispatchers.IO).launch {
    try {
        client.createSudo(sudo)
        // Sudo created successfully.
    } catch (e: SudoProfileException) {
        // Handle error.
    }
}

TypeScript

import { Sudo } from '@sudoplatform/sudo-profiles'

const sudo = new Sudo()
sudo.title = "Mr."
sudo.firstName = "John"
sudo.lastName = "Smith"
sudo.label = "Shopping"
sudo.notes = "Used for shopping."
sudo.setAvatar(avatarFile)

try {
  const createdSudo = await client.createSudo(sudo)
  // Sudo created successfully.
} catch(err) {
  // Handle error.  
}

List Sudos

To list Sudos:

Swift

do {
    let sudos = try await self.sudoProfilesClient.listSudos(option: .remoteOnly)
    for sudo in sudos {
        // Load the avatar image.
        if let avatar = sudo.avatar,
            let data = try? Data(contentsOf: avatar) {
            let image = UIImage(data: data)
        }
    }
} catch let error {
    // Handle error. An error may be thrown if the backend is unable
    // to list Sudos due to availability or for unrecoverable circumstances arising
    // from programmatic error or configuration error. For example, if the keychain
    // access entitlement is not set up correctly, the client is not signed in,
    // or basic system resources are unavailable.
}

Kotlin

CoroutineScope(Dispatchers.IO).launch {
    try {
        val sudos = client.listSudos(ListOption.REMOTE_ONLY)
        for (sudo in sudos) {
            // Load the avatar image.
            val avatar = sudo.avatar
            if (avatar != null) {
                val file = File(avatar)
                val data = file.readBytes()
            }
        }

    } catch (e: SudoProfileException) {
        // Handle error.
    }
}

TypeScript

try {
  const sudos = await client.listSudos()
} catch(err) {
  // Handle error.
}

The list option specifies whether to return the cached entries or fetch the data from the backend. Initially the cache will be empty but is populated the first time the data is fetched from the backend using remoteOnly option. If the app is offline or if it requires a separate action to fetch new data from the backend then use cacheOnly option to show the user with the last known state then update the view when the app is able to fetch new data from the backend. create, update and delete APIs can also update the cache but the cache needs to be hydrated first by invoke list API with remoteOnly.

Modify Sudos

To update an existing Sudo:

Swift

sudo.firstName = "David"
do {
    sudo = try await self.sudoProfilesClient.updateSudo(sudo: sudo)
    // Update successful.
} catch let error {
    // Handle error. An error may be thrown if the backend is unable to
    // update Sudo due to availability or security issues or for unrecoverable 
    // circumstances arising from programmatic error or configuration error. 
    // For example, if the keychain access entitlement is not set up correctly, 
    // the client is not signed in, or basic system resources are unavailable.
}

Kotlin

sudo.firstName = "David"
CoroutineScope(Dispatchers.IO).launch {
    try {
        client.updateSudo(sudo)
        // Sudo updated successfully.
    } catch (e: SudoProfileException) {
        // Handle error.
    }
}

TypeScript

sudo.firstName = "David"
try {
  const updatedSudo = await client.updateSudo(sudo)
  // Sudo updated successfully.
} catch(err) {
  // Handle error.
}

Subscribe to Changes

To subscribe to a specific Sudo change notification:

Swift

class MySubscriber: SudoSubscriber {

    func sudoChanged(changeType: SudoChangeType, sudo: Sudo) {
        // Process new, updated or deleted Sudo.
    }

    func connectionStatusChanged(state: SubscriptionConnectionState) {
        if state == .connected {
            // The subscription is now connected hence the subscribers
            // will start receiving Sudo changes.
        } else if state == .disconnected {
            // The subscription is disconnected and all subscribers were
            // automatically unsubscribed. Subscribe again to establish a 
            // new connection or report the error.
        }
    }

}

let subscriber = MySubscriber()
do {
    try await self.client.subscribe(id: "subscriber_id", changeType: .create, subscriber: subscriber)
} catch let error {
    // Handle error. An error might be thrown for unrecoverable circumstances arising
    // from programmatic error or configuration error. For example, if the keychain
    // access entitlement is not set up correctly, the client is not signed in,
    // or basic system resources are unavailable.
}

Kotlin

class MySubscriber: SudoSubscriber {

    override fun connectionStatusChanged(state: SudoSubscriber.ConnectionState) {
        if (state == SudoSubscriber.ConnectionState.CONNECTED) {
            // The subscription is now connected hence the subscribers
            // will start receiving Sudo changes.
        } else {
            // The subscription is disconnected and all subscribers were
            // automatically unsubscribed. Subscribe again to establish a 
            // new connection or report the error.        
        }
    }

    override fun sudoChanged(changeType: SudoSubscriber.ChangeType, sudo: Sudo) {
        // Process new, updated or deleted Sudo.
    }
}

val subscriber = MySubscriber()
CoroutineScope(Dispatchers.IO).launch {
    client.subscribeAsync("<subscriber_id>", SudoSubscriber.ChangeType.CREATE, subscriber)
}

TypeScript

import { 
  SudoSubscriber, 
  ConnectionState,
  ChangeType, 
  } from '@sudoplatform/sudo-profiles'

class MySubscriber implements SudoSubscriber {
  public sudoChanged(changeType, sudo) {
    // Process new, updated or deleted Sudo.
  }

  public connectionStatusChanged(state) {
    if (state === ConnectionState.Connected) {
        // The subscription is now connected hence the subscribers
        // will start receiving Sudo changes.
    } else {
        // The subscription is disconnected and all subscribers were
        // automatically unsubscribed. Subscribe again to establish a 
        // new connection or report the error.        
    }
  }    
}

try {
  const subscriber = new MySubscriber()
  client.subscribe('subscriber_id', ChangeType.Create, subscriber)
} catch(err) {
  // Handle error.
}

For creating a new Sudo, the subscribers will be notified twice: ".create" notification when the Sudo is created and ".update" notification when the Sudo is updated with claims that requires reference to Sudo ID. The request to create a Sudo is considered complete when both of notifications have been received.

To subscribe to Sudo change notification of all types:

Swift

class MySubscriber: SudoSubscriber {

    func sudoChanged(changeType: SudoChangeType, sudo: Sudo) {
        // Process new, updated or deleted Sudo.
    }

    func connectionStatusChanged(state: SubscriptionConnectionState) {
        if state == .connected {
            // The subscription is now connected hence the subscribers
            // will start receiving Sudo changes.
        } else if state == .disconnected {
            // The subscription is disconnected and all subscribers were
            // automatically unsubscribed. Subscribe again to establish a 
            // new connection or report the error.
        }
    }

}

let subscriber = MySubscriber()
do {
    try await self.client.subscribe(id: "subscriber_id", subscriber: subscriber)
} catch let error {
    // Handle error. An error may be thrown for unrecoverable circumstances arising
    // from programmatic error or configuration error. For example, if the keychain
    // access entitlement is not set up correctly, the client is not signed in,
    // or basic system resources are unavailable.
}

Kotlin

class MySubscriber: SudoSubscriber {

    override fun connectionStatusChanged(state: SudoSubscriber.ConnectionState) {
        if (state == SudoSubscriber.ConnectionState.CONNECTED) {
            // The subscription is now connected hence the subscribers
            // will start receiving Sudo changes.
        } else {
            // The subscription is disconnected and all subscribers were
            // automatically unsubscribed. Subscribe again to establish a 
            // new connection or report the error.        
        }
    }

    override fun sudoChanged(changeType: SudoSubscriber.ChangeType, sudo: Sudo) {
        // Process new, updated or deleted Sudo.
    }
}

val subscriber = MySubscriber()
CoroutineScope(Dispatchers.IO).launch {
    client.subscribeAsync("<subscriber_id>", subscriber)
}

TypeScript

import { 
  SudoSubscriber, 
  ConnectionState,
  ChangeType, 
  } from '@sudoplatform/sudo-profiles'

class MySubscriber implements SudoSubscriber {
  public sudoChanged(changeType, sudo) {
    // Process new, updated or deleted Sudo.
  }

  public connectionStatusChanged(state) {
    if (state === ConnectionState.Connected) {
        // The subscription is now connected hence the subscribers
        // will start receiving Sudo changes.
    } else {
        // The subscription is disconnected and all subscribers were
        // automatically unsubscribed. Subscribe again to establish a 
        // new connection or report the error.        
    }
  }    
}

try {
  const subscriber = new MySubscriber()
  client.subscribeAll('subscriber_id', subscriber)
} catch(err) {
  // Handle error.
}

Delete Sudos

To delete an existing Sudo:

Swift

do {
    try await client.deleteSudo(sudo: sudo) 
    // Delete successful.
} catch let error {
    // Handle error. An error might be thrown if the backend is unable 
    // to delete the Sudo due to availability or security issues or for 
    // unrecoverable circumstances arising from programmatic error or 
    // configuration error. For example, if the keychain access entitlement is 
    // not set up correctly, the client is not signed in, or basic system 
    // resources are unavailable.
}

Kotlin

CoroutineScope(Dispatchers.IO).launch {
    try {
        client.deleteSudo(sudo)
        // Sudo deleted successfully.
    } catch (e: SudoProfileException) {
        // Handle error.
    }
}

TypeScript

try {
  await client.deleteSudo(sudo)
  // Sudo deleted successfully.
} catch(err) {
  // Handle error.
}

Get Ownership Proof

Many Sudo Platform services require the user to present a proof that they own a particular Sudo so that a provisioned resource can be associated with a Sudo. Sudo Profiles SDK provides an API to generate a cryptographic proof of Sudo ownership so it can be used in provisioning APIs of other SDKs such as Email SDK.

To obtain a Sudo ownership proof for provisioning a resource tied to a Sudo.

Swift

do {
    let jwt = try await client.getOwnershipProof(sudo: sudo, audience: "<service_specific_audience>")
    // Ownership proof obtained successfully.
} catch let error {
    // Handle error. An error might be thrown if the backend is unable
    // to delete the Sudo due to availability or security issues or for 
    // unrecoverable circumstances arising from programmatic error or 
    // configuration error. For example, if the keychain access entitlement is 
    // not set up correctly, the client is not signed in, or basic system 
    // resources are unavailable.
}

Kotlin

CoroutineScope(Dispatchers.IO).launch {
    try {
        client.getOwnershipProof(sudo, "<service_specific_audience>")
        // Ownership proof obtained successfully.
    } catch (e: SudoProfileException) {
        // Handle error.
    }
}

TypeScript

try {
  await client.getOwnershipProof(sudoId, "<service_specific_audience>")
  // Ownership proof obtained successfully.
} catch(err) {
  // Handle error.
}

Resetting Client State

You can reset the internal state information maintained by SudoProfilesClient by calling reset API.

Resetting the client state will cause all persistent data to be lost including any cached Sudos and encryption keys. Unless you are intending to import the encryption keys from an external source, e.g. key backup, you should call generateEncryptionKey API to create a new encryption key before using SudoProfileClient again.

Swift

do {
    try client.reset()
} catch let error {
    // Handle error. An error may be thrown for unrecoverable circumstances arising
    // from programmatic error or configuration error. For example, basic system resources
    // are not accessible.
}

Kotlin

client.reset()

TypeScript

try {
  await client.reset()
} catch(err) {
  // Handle error. An error might be thrown for unrecoverable circumstances arising
  // from programmatic error or configuration error. For example, basic system resources
  // are not accessible.
}