Skip to content

Latest commit

 

History

History
237 lines (181 loc) · 9.43 KB

usage-quickeditor.md

File metadata and controls

237 lines (181 loc) · 9.43 KB

Quick Editor Module usage

The :gravatar-quickeditor module provides a fully featured component that allows the user to modify their avatar without leaving your app.

To do that the QuickEditor needs an authorization token to perform requests on behalf of the user. There are two ways for that:

1. Let the Quick Editor handle the OAuth flow

Quick Editor can handle the heavy lifting of running the full OAuth flow, so you don't have to do that. We will still need a few things from you. First, you have to go to OAuth docs and create your Application. Define the Redirect URLs.

Keep in mind that you need to use the https scheme. Internally, QuickEditor uses Implicit OAuth flow (response_type=token) and for security reasons, the server doesn't allow custom URL schemes.

For the sake of this example let's assume the redirect URL is https://yourhost.com/redirect-url.

In your AndroidManifest.xml you need to setup GravatarOAuthActivity by adding the <activity> tag. This Activity is launched by the Quick Editor when starting the OAuth flow and it handles the redirect URL to retrieve the token.

<activity
    android:name="com.gravatar.quickeditor.ui.oauth.GravatarOAuthActivity"
    tools:node="merge">
    <intent-filter android:autoVerify="true">
        <action android:name="android.intent.action.VIEW" />

        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />

        <data
            android:scheme="https"
            android:host="yourhost.com"
            android:pathPrefix="/redirect-url"
        />
    </intent-filter>
</activity>

Make sure to follow official Android App Links documentation to properly setup App Link.

Once you've added that you can add the Quick Editor to your Compose screen:

var showBottomSheet by rememberSaveable { mutableStateOf(false) }

if (showBottomSheet) {
    GravatarQuickEditorBottomSheet(
        gravatarQuickEditorParams = GravatarQuickEditorParams {
            email = Email("{USER_EMAIL}")
            avatarPickerContentLayout = AvatarPickerContentLayout.Horizontal
        },
        authenticationMethod = AuthenticationMethod.OAuth(
            OAuthParams {
                clientId = "{YOUR_CLIENT_ID}"
                redirectUri = "{YOUR_REDIRECT_URL}" // In our example this would be https://yourhost.com/redirect_url
            },
        ),
        onAvatarSelected = { ... },
        onDismiss = { gravatarQuickEditorDismissReason ->
            showBottomSheet = false
            ...
        },
    )
}

With the provided clientId and the redirectUrl Quick Editor will launch and handle the full OAuth flow. Once obtained, the token will be stored in an encrypted Data Store. This token will be later used in subsequent Quick Editor launches to make the user experience more seamless by not having to go through the OAuth flow each time.

When the user logs out form the app, make sure to run:

GravatarQuickEditor.logout(Email("{USER_EMAIL}"))

Exclude Data Store files from Android backup (optional, but recommended)

Data Store files are subject to Android backups. Encrypted files from the backup won't work when restored on a different device so we have to exclude those files. It is encouraged to create those files or copy paste below rules to your own respective files.

Instructions

In AndroidManifest.xml add the below lines. If you already have them, you can skip this step.

<application
        android:allowBackup="true"
        android:dataExtractionRules="@xml/data_extraction_rules"
        android:fullBackupContent="@xml/backup_rules"
        ...>

Create @xml/data_extraction_rules or modify your file with the below rules.

<?xml version="1.0" encoding="utf-8"?>
<data-extraction-rules>
    <cloud-backup>
        <exclude
            domain="sharedpref"
            path="__androidx_security_crypto_encrypted_file_pref__.xml" />
        <exclude
            domain="file"
            path="datastore/quick-editor-preferences.preferences_pb" />
    </cloud-backup>
    <device-transfer>
        <exclude
            domain="sharedpref"
            path="__androidx_security_crypto_encrypted_file_pref__.xml" />
        <exclude
            domain="file"
            path="datastore/quick-editor-preferences.preferences_pb" />
    </device-transfer>
</data-extraction-rules>

Create @xml/backup_rules or modify your file with the below rules.

<?xml version="1.0" encoding="utf-8"?>
<full-backup-content>
    <exclude
        domain="sharedpref"
        path="__androidx_security_crypto_encrypted_file_pref__.xml" />
    <exclude
        domain="file"
        path="datastore/quick-editor-preferences.preferences_pb" />
</full-backup-content>

2. Obtain the token yourself and provide it to the Quick Editor

Quick Editor can be launched with the provided token. To obtain it, you have to follow the OAuth docs and implement the OAuth flow within your app.

Once you have the token, here's how you can embed the QuickEditor in your Compose screen:

var showBottomSheet by rememberSaveable { mutableStateOf(false) }

if (showBottomSheet) {
    GravatarQuickEditorBottomSheet(
        gravatarQuickEditorParams = GravatarQuickEditorParams {
            email = Email("{USER_EMAIL}")
            avatarPickerContentLayout = AvatarPickerContentLayout.Horizontal
        },
        authenticationMethod = AuthenticationMethod.Bearer("{TOKEN}"),
        onAvatarSelected = { ... },
        onDismiss = { gravatarQuickEditorDismissReason ->
            showBottomSheet = false
            ...
        },
    )
}

Activity/Fragment compatibility

Gravatar SDK is built with Compose but we do provide some helper functions to launch the Quick Editor from an Activity or Fragment. Here's an example an Activity:

GravatarQuickEditor.show(
    activity = this,
    gravatarQuickEditorParams = GravatarQuickEditorParams {
        email = Email("{USER_EMAIL}")
        avatarPickerContentLayout = AvatarPickerContentLayout.Horizontal
    },
    authenticationMethod = AuthenticationMethod.Bearer("{TOKEN}"),
    onAvatarSelected = {  ... },
    onDismiss = { gravatarQuickEditorDismissReason -> ... },
)

Cache busting

When an avatar is modified, the change is applied immediately, but it may take a few seconds to propagate through the Gravatar servers. As a result, requesting the avatar quickly using the usual URL might sometimes return the previous avatar.

To ensure you receive the updated avatar after a change, you can use a cache buster. Our SDK provides methods to assist you in this process.

Using AvatarUrl

The AvatarUrl method accepts an optional parameter that we'll add as a cache buster:

public fun url(cacheBuster: String? = null): URL

You can use any string as a cache buster, but ensure that you don't repeat the value when you want to refresh the avatar. A timestamp is a good example of a unique cache buster.

Using the Avatar UI Component

If you're using our UI Avatar component, you can simply enable the forceRefresh parameter when you want to use the cache buster. We'll manage everything for you, updating the cache buster in every recomposition while the forceRefresh parameter remains true.

@Composable
public fun Avatar(
    state: ComponentState<Profile>,
    size: Dp,
    modifier: Modifier = Modifier,
    avatarQueryOptions: AvatarQueryOptions? = null,
    forceRefresh: Boolean = false,
)

By setting forceRefresh to true, you ensure that the avatar is always fetched with the latest changes.

If you want a more fine-grained control with the Avatar component you can use the version that takes the URL as a parameter and pass the URL with the cacheBuster value created with the AvatarUrl class.

@Composable
public fun Avatar(
    state: ComponentState<String>,
    size: Dp,
    modifier: Modifier = Modifier,
)

Android Permissions

The Quick Editor module requires certain permissions to function correctly. Below is a table listing the permissions and the reasons why they are needed:

Permission Reason
INTERNET Required to make network requests to the Gravatar API.
WRITE_EXTERNAL_STORAGE Allows the app to save images to the device storage on Android 9 and lower via Download Manager.

If you use the same permission with different configurations, you might end up with conflicts.

Version migrations

When updating the SDK, you might need to migrate your code to the new version. Here is the list of all the migrations:

Versions Intructions
2.x - 2.3.0 2.x-2.3.0