# register()

A function that registers a placement that can be remotely configured to show a paywall and gate feature access.

Purpose [#purpose]

Registers a placement so that when it's added to a campaign on the Superwall Dashboard, it can trigger a paywall and optionally gate access to a feature.

Signature [#signature]

```kotlin
fun Superwall.register(
    placement: String,
    params: Map<String, Any>? = null,
    handler: PaywallPresentationHandler? = null,
    feature: () -> Unit,
)
```

```kotlin
fun Superwall.register(
    placement: String,
    params: Map<String, Any>? = null,
    handler: PaywallPresentationHandler? = null,
)
```

Parameters [#parameters]

<TypeTable
  type="{
  placement: {
    type: &#x22;String&#x22;,
    description: &#x22;The name of the placement you wish to register.&#x22;,
    required: true,
  },
  params: {
    type: &#x22;Map<String, Any>?&#x22;,
    description: &#x22;Optional parameters to pass with your placement. These can be referenced within campaign rules. Keys beginning with `$` are reserved for Superwall and will be dropped. Arrays and nested maps are currently unsupported and will be ignored.&#x22;,
    default: &#x22;null&#x22;,
  },
  handler: {
    type: &#x22;PaywallPresentationHandler?&#x22;,
    description: &#x22;A handler whose functions provide status updates for the paywall lifecycle.&#x22;,
    default: &#x22;null&#x22;,
  },
  feature: {
    type: &#x22;() -> Unit&#x22;,
    description: &#x22;A completion block representing the gated feature. It is executed based on the paywall's gating mode: called immediately for **Non-Gated**, called after the user subscribes or if already subscribed for **Gated**.&#x22;,
    required: true,
  },
}"
/>

Returns / State [#returns--state]

This function returns `Unit`. If you supply a `feature` lambda, it will be executed according to the paywall's gating configuration, as described above.

Usage [#usage]

## Tab

```swift iOS
func pressedWorkoutButton() {
  // remotely decide if a paywall is shown and if
  // navigation.startWorkout() is a paid-only feature
  Superwall.shared.register(placement: "StartWorkout") {
    navigation.startWorkout()
  }
}
```

## Tab

```kotlin Android
fun pressedWorkoutButton() {
  // remotely decide if a paywall is shown and if
  // navigation.startWorkout() is a paid-only feature
  Superwall.instance.register("StartWorkout") {
    navigation.startWorkout()
  }
}
```

## Tab

```dart Flutter
void pressedWorkoutButton() {
  // remotely decide if a paywall is shown and if
  // navigation.startWorkout() is a paid-only feature
  Superwall.shared.registerPlacement('StartWorkout', feature: () {
      navigation.startWorkout();
  });
}
```

## Tab

```typescript React Native
// remotely decide if a paywall is shown and if
// navigation.startWorkout() is a paid-only feature
Superwall.shared.register({
  placement: 'StartWorkout',
  feature: () => {
    navigation.navigate('LaunchedFeature', {
      value: 'Non-gated feature launched',
    });
  } 
});
```



Register without feature gating:

```kotlin
Superwall.instance.register(
    placement = "onboarding_complete",
    params = mapOf("source" to "onboarding"),
    handler = this
)
```