Подписка на сообщество для Android

1. Выберите способ отображения окна подписки и выполните для него необходимые инструкции:
   • Чтобы отобразить окно подписки в любой момент при использовании приложения, пропишите доступ groups в коде вашего приложения. Если вы используете для авторизации пользовательскую кнопку, то вам подойдёт этот способ отображения окна подписки на сообщество.
   • Чтобы показать окно подписки после авторизации через кнопку One Tap, шторку авторизации или виджет 3 в 1, указывать доступ в коде не нужно, он добавится автоматически.
2. Организуйте работу с подходящим для вас модулем VK ID SDK — Compose или XML. Дальнейшая работа с опцией подписки на сообщество определяется вашим подходом к работе с UI.

Лимиты показа окна подписки на сообщество

• задать количество показов окна;
• указать для этого количества показов период в днях;
• полностью отключить лимиты показа окна.

VKID.init(
    ...
    groupSubscriptionLimit = GroupSubscriptionLimit(
        maxSubscriptionsToShow = 3, // Количество показов окна подписки.
        periodInDays = 7, // Период для этого количества показов.
    )
)

Работа с Compose

Самостоятельный запуск окна подписки на сообщество

• если сервис подключил авторизацию через пользовательскую кнопку;
• если сервис подключил один из элементов быстрого входа и хочет отобразить окно подписки не следующим экраном после авторизации, а в любой другой момент при использовании приложения.

dependencies {
    implementation("com.vk.id:group-subscription-compose:${sdkVersion— указывается последняя версия SDK, смотрите номер версии в начале страницы}")
}

@Composable
fun ScreenWithGroupSubscription() {
    val snackbarHostState = SnackbarHostState()
    GroupSubscriptionSnackbarHost(
        snackbarHostState = snackbarHostState,
    )
}

@Composable
fun ScreenWithGroupSubscription() {
    val snackbarHostState = SnackbarHostState()
    GroupSubscriptionSnackbarHost(/* ... */)

    val state = rememberGroupSubscriptionSheetState()
    GroupSubscriptionSheet(
        state = state,
        groupId = "12345",
        onSuccess = { /* Успешная подписка на сообщество */ },
        onFail = { /* Ошибка во время подписки на сообщество */ },
        snackbarHostState = snackbarHostState,
    )
}

1. Создайте объект state с помощью метода rememberGroupSubscriptionSheetState().
2. Передайте его в окно подписки.

• state.show() — отображает окно;
• state.hide() — cкрывает окно.

@Composable
fun ScreenWithGroupSubscription() {
    ...
    val state = rememberGroupSubscriptionSheetState()
    ...
    Button(onClick = { state.show() })
}

OneTap(
    ...
    authParams = VKIDAuthUIParams {
        scopes = setOf("groups")
    }
)

@Composable
fun ScreenWithGroupSubscription() {
    ...
    GroupSubscriptionSheet(
        ...
        accessTokenProvider = { MyTokenStorage.getAccessToken() },
    )
}

@Composable
fun ScreenWithGroupSubscription() {
    ...
    GroupSubscriptionSheet(
        ...
        style = GroupSubscriptionStyle.Light(
            cornersStyle = GroupSubscriptionSheetCornersStyle.Custom(2f),
            buttonsCornersStyle = GroupSubscriptionButtonsCornersStyle.Default,
            sizeStyle = GroupSubscriptionButtonsSizeStyle.SMALL_32,
        )
    )
}

Окно подписки на сообщество в кнопке One Tap

@Composable
fun ScreenWithOneTap() {
    val snackbarHostState = SnackbarHostState()
    GroupSubscriptionSnackbarHost(
        snackbarHostState = snackbarHostState,
    )
}

@Composable
fun ScreenWithOneTap() {
    val snackbarHostState = SnackbarHostState()
    ...
    OneTap(
        ...
        subscribeToGroupId = "12345",
        onSuccessSubscribingToGroup = { /* Успешная подписка на сообщество */ },
        onFailSubscribingToGroup = { /* Ошибка во время подписки на сообщество */ },
        groupSubscriptionSnackbarHostState = snackbarHostState,
        groupSubscriptionStyle = GroupSubscriptionStyle.Light(),
    )
}

Окно подписки на сообщество в шторке авторизации

@Composable
fun ScreenWithBottomSheet() {
    val snackbarHostState = SnackbarHostState()
    GroupSubscriptionSnackbarHost(
        snackbarHostState = snackbarHostState,
    )
}

@Composable
fun ScreenWithBottomSheet() {
    val snackbarHostState = SnackbarHostState()
    ...
    OneTapBottomSheet(
        ...
        subscribeToGroupId = "12345",
        onSuccessSubscribingToGroup = { /* Успешная подписка на сообщество */ },
        onFailSubscribingToGroup = { /* Ошибка во время подписки на сообщество */ },
        groupSubscriptionSnackbarHostState = snackbarHostState,
        groupSubscriptionStyle = GroupSubscriptionStyle.Light(),
    )
}

Окно подписки на сообщество в виджете 3 в 1

@Composable
fun ScreenWithBottomSheet() {
    val snackbarHostState = SnackbarHostState()
    GroupSubscriptionSnackbarHost(
        snackbarHostState = snackbarHostState,
    )
}

@Composable
fun ScreenWithBottomSheet() {
    val snackbarHostState = SnackbarHostState()
    ...
    OAuthListWidget(
        ...
        subscribeToGroupId = "12345",
        onSuccessSubscribingToGroup = { /* Успешная подписка на сообщество */ },
        onFailSubscribingToGroup = { /* Ошибка во время подписки на сообщество */ },
        groupSubscriptionSnackbarHostState = snackbarHostState,
        groupSubscriptionStyle = GroupSubscriptionStyle.Light(),
    )
}

Работа с XML

Самостоятельный запуск окна подписки на сообщество

• если сервис подключил авторизацию через пользовательскую кнопку;
• если сервис подключил один из элементов быстрого входа и хочет отобразить окно подписки не следующим экраном после авторизации, а в любой другой момент при использовании приложения.

dependencies {
    implementation("com.vk.id:group-subscription-xml:${sdkVersion— указывается последняя версия SDK, смотрите номер версии в начале страницы}")
}

1. Разместите в вёрстке объект GroupSubscriptionSnackbarHost:
   <com.vk.id.group.subscription.xml.GroupSubscriptionSnackbarHost
           android:id="@+id/group_subscription_snackbar_host"
           android:layout_width="match_parent"
           android:layout_height="match_parent" />

2. Укажите на объект ссылку через property snackbarHost:
   findViewById<GroupSubscriptionSheet>(R.id.group_subscription).snackbarHost
       = findViewById<GroupSubscriptionSnackbarHost>(R.id.group_subscription_snackbar_host)

1. Разместите в вёрстке объект GroupSubscriptionSheet:
   <com.vk.id.group.subscription.xml.GroupSubscriptionSheet
           android:id="@+id/group_subscription"
           android:layout_width="0dp"
           android:layout_height="0dp"
           app:vkid_groupId="1" />

2. Настройте параметры объекта:
   findViewById<GroupSubscriptionSheet>(R.id.group_subscription).apply {
       setCallbacks(
           onSuccess = { /* Успешная подписка на сообщество */ },
           onFail = { /* Ошибка во время подписки на сообщество */ },
       )
       groupId = "12345"
   }

• show() — отображает окно;
• hide() — скрывает окно.

findViewById<GroupSubscriptionSheet>(R.id.group_subscription).show()

val view = findViewById<OneTap>(R.id.onetap)
view.scopes = setOf("groups")

<com.vk.id.onetap.xml.OneTap
    ...
    app:vkid_onetapScopes="groups"
/>

• если сервис подключил авторизацию через пользовательскую кнопку;
• если сервис подключил один из элементов быстрого входа и хочет отобразить окно подписки не следующим экраном после авторизации, а в любой другой момент при использовании приложения.

findViewById<GroupSubscriptionSheet>(R.id.group_subscription).accessTokenProvider = { MyTokenStorage.getAccessToken() }

fun onCreate(/* ... */) {
    findViewById<GroupSubscriptionSheet>(R.id.group_subscription).style = GroupSubscriptionStyle.Light(
        cornersStyle = GroupSubscriptionSheetCornersStyle.Custom(2f),
        buttonsCornersStyle = GroupSubscriptionButtonsCornersStyle.Default,
        sizeStyle = GroupSubscriptionButtonsSizeStyle.SMALL_32,
    )
}

<com.vk.id.group.subscription.xml.GroupSubscriptionSnackbarHost
        android:id="@+id/group_subscription_snackbar_host"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        app:vkid_groupSubscriptionButtonCorners="0dp"
        app:vkid_groupSubscriptionButtonSize="small32"
        app:vkid_groupSubscriptionCorners="1dp"
        app:vkid_groupSubscriptionStyle="system" />

Окно подписки на сообщество в кнопке One Tap

1. Разместите в вёрстке объект GroupSubscriptionSnackbarHost:
   <com.vk.id.group.subscription.xml.GroupSubscriptionSnackbarHost
           android:id="@+id/group_subscription_snackbar_host"
           android:layout_width="match_parent"
           android:layout_height="match_parent" />

2. Укажите на объект ссылку через property snackbarHost:
   findViewById<OneTap>(R.id.one_tap).snackbarHost
       = findViewById<GroupSubscriptionSnackbarHost>(R.id.group_subscription_snackbar_host)

1. Разместите в вёрстке объект OneTap:
   <com.vk.id.onetap.xml.OneTap
           android:id="@+id/one_tap"
           app:vkid_groupId="12345" />

2. Настройте параметры объекта:
   findViewById<OneTap>(R.id.one_tap).apply {
       setGroupSubscriptionCallbacks(
           onSuccess = { /* Успешная подписка на сообщество */ },
           onFail = { /* Ошибка во время подписки на сообщество */ },
       )
       groupId = "12345"
   }

Окно подписки на сообщество в шторке авторизации

1. Разместите в вёрстке объект GroupSubscriptionSnackbarHost:
   <com.vk.id.group.subscription.xml.GroupSubscriptionSnackbarHost
           android:id="@+id/group_subscription_snackbar_host"
           android:layout_width="match_parent"
           android:layout_height="match_parent" />

2. Укажите на объект ссылку через функцию snackbarHost:
   findViewById<OneTapBottomSheet>(R.id.one_tap).snackbarHost
       = findViewById<GroupSubscriptionSnackbarHost>(R.id.group_subscription_snackbar_host)

1. Разместите в вёрстке объект OneTapBottomSheet:
   <com.vk.id.onetap.xml.OneTapBottomSheet
           android:id="@+id/one_tap_bottom_sheet"
           app:vkid_groupId="12345" />

2. Настройте параметры объекта:
   findViewById<OneTapBottomSheet>(R.id.one_tap_bottom_sheet).apply {
       setGroupSubscriptionCallbacks(
           onSuccess = { /* Успешная подписка на сообщество */ },
           onFail = { /* Ошибка во время подписки на сообщество */ },
       )
       groupId = "12345"
   }

Окно подписки на сообщество в виджете 3 в 1

1. Разместите в вёрстке объект GroupSubscriptionSnackbarHost:
   <com.vk.id.group.subscription.xml.GroupSubscriptionSnackbarHost
           android:id="@+id/group_subscription_snackbar_host"
           android:layout_width="match_parent"
           android:layout_height="match_parent" />

2. Укажите на объект ссылку через функцию snackbarHost:
   findViewById<OAuthListWidget>(R.id.oauth_list_widget).snackbarHost
       = findViewById<GroupSubscriptionSnackbarHost>(R.id.group_subscription_snackbar_host)

1. Разместите в вёрстке объект OAuthListWidget:
   <com.vk.id.onetap.xml.OAuthListWidget
           android:id="@+id/no_multibranding_one_tap"
           app:vkid_groupId="12345" />

2. Настройте параметры объекта:
   findViewById<OAuthListWidget>(R.id.oauth_list_widget).apply {
       setGroupSubscriptionCallbacks(
           onSuccess = { /* Успешная подписка на сообщество */ },
           onFail = { /* Ошибка во время подписки на сообщество */ },
       )
       groupId = "12345"
   }

Ошибки