Type alias GrantPermissionProps

GrantPermissionProps: {
    additionalReasoning?: string;
    cancelText: string;
    componentProps?: ViewProps;
    continueText: string;
    customImage?: ImageSourcePropType;
    imageStyle?: StyleProp<ViewStyle>;
    reasoning: string;
    resultsCallback: ((result) => void);
    style?: StyleProp<ViewStyle>;
    title: string;
    type?: "files" | "camera" | "notifications" | "location";
}

Props for GrantPermission component

Type declaration

  • Optional additionalReasoning?: string

    Additional info or reasoning to show (Ex: "Please allow APP_NAME to access your photos when you are prompted.")

  • cancelText: string

    Text to show for cancel action (usually "Cancel" or similar)

  • Optional componentProps?: ViewProps

    Direct props to set on the React Native component (including iOS and Android specific props). Most use cases should not need this.

  • continueText: string

    Text to show for primary action (usually "Continue" or similar)

  • Optional customImage?: ImageSourcePropType

    Custom image (override type image)

  • Optional imageStyle?: StyleProp<ViewStyle>

    Custom image styles

  • reasoning: string

    Reasoning for needing permission (Ex: "In order for us to retrieve the content you intend to upload, we will need access to your photos. This will be used for upload purposes only.")

  • resultsCallback: ((result) => void)
      • (result): void
      • Callback when flow finishes. Returns success variable indicating if user accepted or refused to move forward with permission flow

        Parameters

        • result: boolean

        Returns void

  • Optional style?: StyleProp<ViewStyle>

    Style to set on the item

  • title: string

    Title for view (usually "Grant access" or similar)

  • Optional type?: "files" | "camera" | "notifications" | "location"

    The type of permission. This will prefill image and style. You can override image for any other custom cases and leave this undefined.

Generated using TypeDoc