Screen Properties

---

1. Set screen orientation (setDeviceOrientation)

Set the device's screen orientation to landscape or portrait. If you need to change the orientation only on a specific screen, be sure to restore the original orientation when leaving the screen.

Signature

function setDeviceOrientation(options: { type: 'portrait' | 'landscape' }): Promise<void>;

Parameters

• options.type · Required · 'portrait' | 'landscape'

  Specifies the screen orientation. portraitis portrait mode, landscapeis landscape mode.

Example

Web (JS)

import { setDeviceOrientation } from '@apps-in-toss/web-framework';

setDeviceOrientation({ type: 'landscape' });

Web (React)

import { setDeviceOrientation } from '@apps-in-toss/web-framework';
import { useEffect } from 'react';

function VideoScreen() {
  useEffect(() => {
    setDeviceOrientation({ type: 'landscape' });

    return () => {
      setDeviceOrientation({ type: 'portrait' }); // Restore it when leaving the screen.
    };
  }, []);
}

React Native

import { setDeviceOrientation } from '@apps-in-toss/framework';
import { useEffect } from 'react';

function VideoScreen() {
  useEffect(() => {
    setDeviceOrientation({ type: 'landscape' });

    return () => {
      setDeviceOrientation({ type: 'portrait' }); // Restore it when leaving the screen.
    };
  }, []);
}

---

2. Set screen to always stay on (setScreenAwakeMode)

Prevent the screen from turning off automatically. Useful for situations where the screen needs to stay on, such as webtoons, videos, or reading documents. If used only on a specific screen, be sure to disable it when leaving the screen.

Signature

function setScreenAwakeMode(options: { enabled: boolean }): Promise<{ enabled: boolean }>;

Parameters

• options.enabled · Required · boolean

  trueIf set to this value, the screen won't turn off, falseIf set to this value, it turns off according to the default screen saver timeout.

Example

Web (React)

import { setScreenAwakeMode } from '@apps-in-toss/web-framework';
import { useEffect } from 'react';

function MediaScreen() {
  useEffect(() => {
    setScreenAwakeMode({ enabled: true });

    return () => {
      setScreenAwakeMode({ enabled: false }); // Restore it when leaving the screen.
    };
  }, []);
}

React Native

import { setScreenAwakeMode } from '@apps-in-toss/framework';
import { useEffect } from 'react';

function MediaScreen() {
  useEffect(() => {
    setScreenAwakeMode({ enabled: true });

    return () => {
      setScreenAwakeMode({ enabled: false }); // Restore it when leaving the screen.
    };
  }, []);
}

---

3. Block screen capture (setSecureScreen)

Block screen capture at the native level. Can be used on screens that display sensitive information such as account balances and transaction history.

Signature

function setSecureScreen(options: { enabled: boolean }): Promise<{ enabled: boolean }>;

Parameters

• options.enabled · Required · boolean

  trueIf set to this value, screen capture is blocked, falseIf set to this value, it is allowed.

Example

import { setSecureScreen } from '@apps-in-toss/framework';
import { useEffect } from 'react';

function SecureScreen() {
  useEffect(() => {
    setSecureScreen({ enabled: true });

    return () => {
      setSecureScreen({ enabled: false }); // Remove the restriction when leaving the screen.
    };
  }, []);
}