### Install VK Mini Apps API with npm

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/README.md

Command to install the @vkontakte/vk-mini-apps-api library as a dependency using the npm package manager.

```Shell
$ npm install @vkontakte/vk-mini-apps-api
```

--------------------------------

### Install VK Mini Apps API with Yarn

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/README.md

Command to add the @vkontakte/vk-mini-apps-api library as a dependency using the Yarn package manager.

```Shell
$ yarn add @vkontakte/vk-mini-apps-api
```

--------------------------------

### Using VK Mini Apps API in Browser (UMD)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/README.md

Shows how to include the UMD build of the library in an HTML file and access the VKMiniAppAPI class via the window.vkMiniAppsAPI object. It demonstrates initialization and fetching user info.

```HTML
<script src="index.umd.js"></script>

<script>
  const { VKMiniAppAPI } = window.vkMiniAppsAPI;

  // Creating API instance
  const api = new VKMiniAppAPI();

  // Initializing app
  api.initApp();

  // Using methods
  api.getUserInfo().then(userInfo => {
    console.log(userInfo.id);
  });
</script>
```

--------------------------------

### Calling postToWall (TypeScript)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Requests the user to post to the wall. Parameters: `message` (string - Post message. If you want to publish only attachments, specify an empty string.), `attachments?` (string | string | object[]), `options?` ([WallPostOptions]). Returns: `Promise<number>` (Published post ID).

```TypeScript
▸ **postToWall**(`message`: string, `attachments?`: string | string | object[], `options?`: [WallPostOptions](../globals.md#wallpostoptions)): *Promise‹number›*
```

--------------------------------

### Using VK Mini Apps API in JavaScript (Module)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/README.md

Demonstrates how to import, initialize, and use the VKMiniAppAPI class in a modern JavaScript environment using ES modules. It shows fetching user info.

```JavaScript
import { VKMiniAppAPI } from '@vkontakte/vk-mini-apps-api';

// Creating API instance
const api = new VKMiniAppAPI();

// Initializing app
api.initApp();

// Using methods
api.getUserInfo().then(userInfo => {
  console.log(userInfo.id);
});
```

--------------------------------

### showInviteBox - VK Mini Apps API

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Opens friends list for inviting to the app.

Returns: Promise<void>

```typescript
showInviteBox(): Promise<void>
```

--------------------------------

### Calling getClientVersion (TypeScript)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Returns the client's platform and version. Returns: `Promise<object>`.

```TypeScript
▸ **getClientVersion**(): *Promise‹object›*
```

--------------------------------

### flashGetInfo - VK Mini Apps API

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Requests device's flashlight information.

Returns: Promise<object> - Availability and level of the flashlight.

```typescript
flashGetInfo(): Promise<object>
```

--------------------------------

### showOrderBox - VK Mini Apps API

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Shows item order box.

Parameters:
itemName: string - Name of product. Will be transmitted in the notification of receipt of product information.

Returns: Promise<VKBridge.OrderBoxShowingStatus> - Status of ordering.

```typescript
showOrderBox(itemName: string): Promise<VKBridge.OrderBoxShowingStatus>
```

--------------------------------

### showLeaderBoardBox - VK Mini Apps API

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Shows leaderboard.

Parameters:
userResult: number - User result.

Returns: Promise<void>

```typescript
showLeaderBoardBox(userResult: number): Promise<void>
```

--------------------------------

### showRequestBox - VK Mini Apps API

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Shows box for sending request to the user.

Parameters:
userId: number - User Id.
message: string - Request test.
requestKey?: undefined | string - (No description provided).

Returns: Promise<object> - Success flag and request key.

```typescript
showRequestBox(userId: number, message: string, requestKey?: undefined | string): Promise<object>
```

--------------------------------

### Calling openApp (TypeScript)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Opens a sub app. Parameters: `appId` (number - App id to open), `locationHash?` (undefined | string - String in location after `#`). Returns: `Promise<void>`.

```TypeScript
▸ **openApp**(`appId`: number, `locationHash?`: undefined | string): *Promise‹void›*
```

--------------------------------

### resizeWindow - VK Mini Apps API

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Resizes iframe size in web.

Parameters:
width: number - Width of iframe.
height: number - (No description provided).

Returns: Promise<object> - Result size of the iframe.

```typescript
resizeWindow(width: number, height: number): Promise<object>
```

--------------------------------

### Calling getUserInfo (TypeScript)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Requests the main user data. Returns: `Promise<VKBridge.UserInfo>` (User data).

```TypeScript
▸ **getUserInfo**(): *Promise‹VKBridge.UserInfo›*
```

--------------------------------

### Calling openCodeReader (TypeScript)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Opens QR codes and barcodes reader. Returns: `Promise<string>` (Read data).

```TypeScript
▸ **openCodeReader**(): *Promise‹string›*
```

--------------------------------

### Calling getAccessToken (TypeScript)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Requests user's access and returns an access token. Parameters: `appId` (number), `scope?` ([UserAccessScope][] | string). Returns: `Promise<object>` (User's access token and list of accessed scopes).

```TypeScript
▸ **getAccessToken**(`appId`: number, `scope?`: [UserAccessScope](../globals.md#useraccessscope)[] | string): *Promise‹object›*
```

--------------------------------

### enableSwipeBack - VK Mini Apps API

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Enables SwipeBack on iOS.

Returns: Promise<void>

```typescript
enableSwipeBack(): Promise<void>
```

--------------------------------

### scrollTo - VK Mini Apps API

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Scrolls window to specified point.

Parameters:
offsetTop: number - Offset top.
speed: number - (No description provided). Default: 0.

Returns: Promise<object> - Offset top and height of window after scroll.

```typescript
scrollTo(offsetTop: number, speed: number): Promise<object>
```

--------------------------------

### Calling getFriends (TypeScript)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Displays a modal with friend select. Parameters: `isMultiple?` (undefined | false | true). Returns: `Promise<object[]>` (List of selected users data).

```TypeScript
▸ **getFriends**(`isMultiple?`: undefined | false | true): *Promise‹object[]›*
```

--------------------------------

### Calling getEmail (TypeScript)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Requests user email. Returns: `Promise<object>` (User email and sign of received data).

```TypeScript
▸ **getEmail**(): *Promise‹object›*
```

--------------------------------

### setLocationHash - VK Mini Apps API

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Sets location hash to the app (vk.com/app123#hash).

Parameters:
hash: string - (No description provided).

Returns: Promise<void>

```typescript
setLocationHash(hash: string): Promise<void>
```

--------------------------------

### setViewSettings - VK Mini Apps API

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Changes the appearance of the mini app interface in mobile clients.

Parameters:
statusBarStyle: VKBridge.AppearanceType - Status bar style type: `light` or `dark`.
actionBarColor?: undefined | string - (No description provided).
navigationBarColor?: undefined | string - (No description provided).

Returns: Promise<void>

```typescript
setViewSettings(statusBarStyle: VKBridge.AppearanceType, actionBarColor?: undefined | string, navigationBarColor?: undefined | string): Promise<void>
```

--------------------------------

### Calling getGeodata (TypeScript)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Requests user geodata. Returns: `Promise<object>` (Object with current user geodata).

```TypeScript
▸ **getGeodata**(): *Promise‹object›*
```

--------------------------------

### flashSetLevel - VK Mini Apps API

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Sets device's flashlight level.

Parameters:
level: number - The flashlight level from 0 to 1.

Returns: Promise<void>

```typescript
flashSetLevel(level: number): Promise<void>
```

--------------------------------

### Calling getPersonalCard (TypeScript)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Requests user to enter some contact data. Parameters: `types` (VKBridge.PersonalCardType[] - Array of required data types: `phone`, `email`, `address`). Returns: `Promise<VKBridge.PersonalCardData>` (Entered user data).

```TypeScript
▸ **getPersonalCard**(`types`: VKBridge.PersonalCardType[]): *Promise‹VKBridge.PersonalCardData›*
```

--------------------------------

### Calling closeApp (TypeScript)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Closes a sub app opened via the `openApp` method. Sends data to the parent app if needed. Parameters: `status` ([CloseStatus]), `payload?` (any). Returns: `Promise<void>`.

```TypeScript
▸ **closeApp**(`status`: [CloseStatus](../globals.md#closestatus), `payload?`: any): *Promise‹void›*
```

--------------------------------

### Calling openContacts (TypeScript)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Opens a selecting contact from the contact list on the user's device. If user has closed the contact list, called the `VKWebAppContactsClosed` event. Returns: `Promise<object>` (Selected contact).

```TypeScript
▸ **openContacts**(): *Promise‹object›*
```

--------------------------------

### onGyroscopeChanged - VK Mini Apps API

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Calls `VKWebAppGyroscopeStart` method and subscribes a function for listening the `VKWebAppGyroscopeChanged` event.

Parameters:
callback: function - Function to pass received data. The callback function receives `data` of type `VKBridge.ReceiveData<"VKWebAppGyroscopeChanged">`.

Returns: (Anonymous function) - Function for unsubscribe.

```typescript
onGyroscopeChanged(callback: function): (Anonymous function)
```

--------------------------------

### Calling denyNotifications (TypeScript)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Disallows notifications. Returns: `Promise<void>`.

```TypeScript
▸ **denyNotifications**(): *Promise‹void›*
```

--------------------------------

### Calling getPhoneNumber (TypeScript)

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Requests user's phone number. Returns: `Promise<object>` (Phone number and signature of received phone for server-side validation).

```TypeScript
▸ **getPhoneNumber**(): *Promise‹object›*
```

--------------------------------

### disableSwipeBack - VK Mini Apps API

Source: https://github.com/vkcom/vk-mini-apps-api/blob/master/docs/classes/vkminiappapi.md

Disables SwipeBack on iOS.

Returns: Promise<void>

```typescript
disableSwipeBack(): Promise<void>
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.