setPageOrientation(params: Object)

Requires:
MiniKit≥2.4.1@ray-js/ray≥0.3.23
Platforms:
iOSAndroid
import { setPageOrientation } from '@ray-js/ray';

// Promise usage
try {
  const res = await setPageOrientation({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Description

Screen orientation setting: auto / portrait / landscape. Rotation is not supported in pad mode

Parameters

PropertyTypeRequiredDescriptionMiniKit Since
pageOrientationstringYesScreen orientation setting: auto / portrait / landscape (default: landscape-right)-
reversebooleanNoWhether to use reverse rotation; only effective when pageOrientation is landscape; default falsev3.24.0
complete() => voidNoCompletion callback (executed on both success and failure)-
success() => voidNoCallback on successful API call-
fail(params: Object) => voidNoFailure callback-
fail callback parameters
PropertyTypeDescription
errorMsgstringError message
errorCodestring | numberError code
Error extension

Return Value

None

Examples

import { setPageOrientation } from '@ray-js/ray'

setPageOrientation({
  pageOrientation: "portrait",
  reverse: false,
  success: data => { console.log(data); },
  fail: error => { console.error(error); },
});