Skip to content

Commit

Permalink
split methods to files and big update
Browse files Browse the repository at this point in the history
  • Loading branch information
mrilyew committed Dec 14, 2024
1 parent 2964e6e commit 1087814
Show file tree
Hide file tree
Showing 163 changed files with 1,610 additions and 2,318 deletions.
10 changes: 4 additions & 6 deletions docs/openvk_engine/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

VKontakte belongs to Pavel Durov and VK Group.

To be honest, we don't even know whether it even works. However, this version is maintained and we will be happy to accept your bugreports [in our bug-tracker](https://github.com/openvk/openvk/projects/1). You should also be able to submit them using [ticketing system](https://openvk.su/support?act=new) (you will need an OVK account for this).
To be honest, we don't even know whether it even works. However, this version is maintained and we will be happy to accept your bugreports [in our bug-tracker](https://github.com/openvk/openvk/projects/1). You should also be able to submit them using [ticketing system](https://ovk.to/support?act=new) (you will need an OVK account for this).

## When's the release?

Expand All @@ -14,8 +14,7 @@ Updating the source code is done with this command: `git pull --recurse-submodul

## Instances

* **[openvk.su](https://openvk.su/)**
* [social.fetbuk.ru](http://social.fetbuk.ru/)
You can see them [here](https://github.com/OpenVK/openvk/wiki/Instances).

## Can I create my own OpenVK instance?

Expand Down Expand Up @@ -64,9 +63,8 @@ You also not required to publish source texts of your themepacks and plugins.
You may reach out to us via:

* [Bug-tracker](https://github.com/openvk/openvk/projects/1)
* [Ticketing system](https://openvk.su/support?act=new)
* Telegram chat: Go to [our channel](https://t.me/openvk) and open discussion in our channel menu.
* [Reddit](https://www.reddit.com/r/openvk/)
* [Ticketing system](https://ovk.to/support?act=new)
* Telegram comments: On [our channel](https://t.me/openvk).
* [Discussions](https://github.com/openvk/openvk/discussions)

!!! attention
Expand Down
20 changes: 20 additions & 0 deletions docs/openvk_engine/api/methods/account/ban.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
### `account.ban` 🔰

Adds user to blacklist.

**Params**:

|Name|Value|Description|
|--|--|--|
|`owner_id`|unsigned int|ID of user|

**Result**

Returns `1` on success.

**Possible errors**:

|Code|Description|
|--|--|
|15|Access denied: cannot blacklist yourself|
|-7856|Blacklist limit exceeded|
3 changes: 3 additions & 0 deletions docs/openvk_engine/api/methods/account/getBalance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
### `account.getBalance` 🔰

Returns JSON object with `votes` field, that contains your votes count.
15 changes: 15 additions & 0 deletions docs/openvk_engine/api/methods/account/getBanned.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### `account.getBanned` 🔰

Returns users in blacklist.

**Params**:

|Name|Value|Description|
|--|--|--|
|`offset`|unsigned int|-|
|`count`|unsigned int|-|
|`fields`|unsigned int|Fields, that will be applied to user objects|

**Result**

Returns `count` and `items` fields.
3 changes: 3 additions & 0 deletions docs/openvk_engine/api/methods/account/getCounters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
### `account.getCounters` 🔰

Returns the counters of Unread `Messages`, `Notifications` and `Friends` Requests.
21 changes: 21 additions & 0 deletions docs/openvk_engine/api/methods/account/getInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
### `account.getInfo` 🔰

*This is a dummy function*

```json
{
"response": {
"2fa_required": 0,
"country": "CZ",
"eu_user": false,
"https_required": 1,
"intro": 0,
"community_comments": false,
"is_live_streaming_enabled": false,
"is_new_live_streaming_enabled": false,
"lang": 1,
"no_wall_replies": 0,
"own_posts_default": 0
}
}
```
17 changes: 17 additions & 0 deletions docs/openvk_engine/api/methods/account/getOvkSettings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
### `account.getOvkSettings` 🔰

Returns:

```json
{
"response":
{
"avatar_style": 0,
"style": "ovk", # current user's theme
"show_rating": 0, # is rating shown
"nsfw_tolerance": 1,
"post_view": "old",
"main_page": "my_page"
}
}
```
24 changes: 24 additions & 0 deletions docs/openvk_engine/api/methods/account/getProfileInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
### `account.getProfileInfo` 🔰

Returns the info about account like:

```json
{
"response":
{
"first_name": "Vladimir",
"id": 1,
"is_verified": 1,
"last_name": "Barinov",
"home_town": "Moscow",
"nickname": "veselcraft",
"status": "Status example",
"bdate": "1.1.1970",
"bdate_visibility": 0,
"phone": "+420 ** *** 228",
"relation": 2,
"sex": 2,
"screen_name": "vc"
}
}
```
15 changes: 15 additions & 0 deletions docs/openvk_engine/api/methods/account/saveProfileInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### `account.saveProfileInfo` 🔰

Params:

|Name|Value|Description|
|--|--|--|
|`first_name`|string|New first name
|`last_name`|string|New last name|
|`screen_name`|string|New shortcode|
|`sex`|int (0 — male, 1 — female)|New `sex` value|
|`relation`|int (0 — 8)|New maritial status|
|`bdate`|string|New birthday|
|`bdate_visibility`|int (1, 2)|New birthday visibility|
|`home_town`|string|New `hometown`|
|`status`|string|New page status (can also be changed via `status.set`)|
23 changes: 23 additions & 0 deletions docs/openvk_engine/api/methods/account/sendVotes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
### `account.sendVotes` 🔰

**Warning**: this method is incompatible with VK API.

Send votes to user.

**Params**:
|Name|Value|Description|
|--|--|--|
|`reciever`|unsigned int|ID of reciever|
|`value`|unsigned int|Count of voices|
|`message`|string|Message, that will be seen in notification.|

**Possible errors**:

|Code|Description|
|--|--|
|-105|Commerce is disabled on this instance|
|-248|Invalid reciever id|
|-249|Message is too long|
|-252|Not enough votes|
|-250|Invalid reciever|
|-251|Can't transfer votes to yourself|
5 changes: 5 additions & 0 deletions docs/openvk_engine/api/methods/account/setOnline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
### `account.setOnline` 🔰

Updates online on your profile.

Returns `1`.
13 changes: 13 additions & 0 deletions docs/openvk_engine/api/methods/account/unban.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### `account.ban` 🔰

Removes user from blacklist.

**Params**:

|Name|Value|Description|
|--|--|--|
|`owner_id`|unsigned int|ID of user|

**Result**

Returns `1` on success.
15 changes: 15 additions & 0 deletions docs/openvk_engine/api/methods/audio/add.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### `audio.add` 🔰

Adds audio to collection.

**Params**:

|Name|Value|Description|
|--|--|--|
|`audio_id`|int|Audio id|
|`owner_id`|int|Audio owner id|
|`group_id`|int|Group id (if needed)|

**Result**:

Returns audio id on success.
15 changes: 15 additions & 0 deletions docs/openvk_engine/api/methods/audio/addAlbum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### `audio.addAlbum` 🔰

Creates new album.

**Params**:

|Name|Value|Description|
|--|--|--|
|`title`|string|Playlist title|
|`description`|string|Playlist description|
|`group_id`|int|Set owner as group|

**Result**:

Returns album id on success.
14 changes: 14 additions & 0 deletions docs/openvk_engine/api/methods/audio/beacon.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### `audio.beacon` 🔰

Sets audiostatus.

**Params**:

|Name|Value|Description|
|--|--|--|
|`aid`|unsigned int|Audio id|
|`gid`|unsigned int|Group id (not visible at web version)|

**Result**:

Returns `1` on success.
13 changes: 13 additions & 0 deletions docs/openvk_engine/api/methods/audio/bookmarkAlbum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### `audio.bookmarkAlbum` 🔰

Adds album to your collection

**Params**:

|Name|Value|Description|
|--|--|--|
|`id`|int|Playlist id|

**Result**:

Returns 1 on success.
15 changes: 15 additions & 0 deletions docs/openvk_engine/api/methods/audio/delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### `audio.delete` 🔰

Removes audio from collection.

**Params**:

|Name|Value|Description|
|--|--|--|
|`audio_id`|int|Audio id|
|`owner_id`|int|Audio owner id|
|`group_id`|int|Group id (if needed)|

**Result**:

Returns 1 on success.
13 changes: 13 additions & 0 deletions docs/openvk_engine/api/methods/audio/deleteAlbum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### `audio.deleteAlbum` 🔰

Completely deletes album.

**Params**:

|Name|Value|Description|
|--|--|--|
|`album_id`|int|Playlist id|

**Result**:

Returns 1 on success.
19 changes: 19 additions & 0 deletions docs/openvk_engine/api/methods/audio/edit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
### `audio.edit` 🔰

Edits audio.

**Params**:

|Name|Value|Description|
|--|--|--|
|`owner_id`|int|Audio owner id|
|`audio_id`|int|Audio id|
|`artist`|string|New artists name|
|`title`|string|New songs name|
|`text`|string|New lyrics|
|`genre_str`|string|New genre name|
|`no_search`|bool|Is available in search|

**Result**:

Returns 1 on success.
15 changes: 15 additions & 0 deletions docs/openvk_engine/api/methods/audio/editAlbum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### `audio.editAlbum` 🔰

Edits album.

**Params**:

|Name|Value|Description|
|--|--|--|
|`album_id`|int|Playlist id|
|`title`|string|Playlist title|
|`description`|string|Playlist description|

**Result**:

Returns 1 on success.
18 changes: 18 additions & 0 deletions docs/openvk_engine/api/methods/audio/get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### `audio.get` 🔰

Returns audios with some conditions.

**Params**:

|Name|Value|Description|
|--|--|--|
|`owner_id`|int|If passed, returns audios from user/club's collection|
|`album_id`|unsigned int|If passed, returns audios from playlist|
|`audio_ids`|string|If passed, returns audios by ids|
|`offset`|unsigned int|Offset.|
|`count`|unsigned int|Count.|
|`uploaded_only`|bool|If passed, returns only uploaded audios by user|

**Result**:

Returns `count` and `items` fields.
15 changes: 15 additions & 0 deletions docs/openvk_engine/api/methods/audio/getAlbums.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### `audio.getAlbums` 🔰

Returns users/groups playlist collection.

**Params**:

|Name|Value|Description|
|--|--|--|
|`owner_id`|int|Get from his collection|
|`offset`|int|Offset|
|`count`|int|Count|

**Result**:

Returns 1 on success.
10 changes: 10 additions & 0 deletions docs/openvk_engine/api/methods/audio/getBroadcastList.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
### `audio.getBroadcastList` 🔰

Returns friends/groups that currently broadcasting music.

**Params**:

|Name|Value|Description|
|--|--|--|
|`filter`|string|`all`,`friends`,`groups`|
|`hash`|string|-|
15 changes: 15 additions & 0 deletions docs/openvk_engine/api/methods/audio/getById.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
### `audio.getById` 🔰

Returns audios by his ids

**Params**:

|Name|Value|Description|
|--|--|--|
|`audios`|string|CSV array with audio ids|
|`hash`|string|не знаю|
|`need_user`|bool (0, 1)|On 1 returns uploader|

**Result**:

Returns `count` and `items`.
Loading

0 comments on commit 1087814

Please sign in to comment.