---
name: "setPageOrientation"
mode: "kit"
versionRequirements:
  - { name: "MiniKit", version: "2.4.1" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
---

## setPageOrientation

> [VERSION] MiniKit >= 2.4.1 | @ray-js/ray >= 0.3.23

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

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

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `pageOrientation` | `string` | Yes | - | `2.4.1` | Screen orientation setting: auto / portrait / landscape (default: landscape-right) |
| `reverse` | `boolean` | No | - | `3.24.0` | Whether to use reverse rotation; only effective when pageOrientation is landscape; default false |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `() => void` | No | - | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Examples

#### Demo

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

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