Index

Modules: shizuka/core/compiletime, shizuka/core/consts, shizuka/core/enums, shizuka/core/exceptions, shizuka/private/tools, shizuka/private/user_event, shizuka/vk/button, shizuka/vk/keyboard, shizuka/vk/longpoll, shizuka/vk/template_elem, shizuka/vk/template_vk, shizuka/vk/uploader, shizuka/vk/vk.

API symbols

`$`:

• button: `$`(btn: ButtonObj): string
• keyboard: `$`(kb: KeyboardRef): string
• template_elem: `$`(t: TElementObj): string
• template_vk: `$`(t: TemplateRef): string

`@`:

• compiletime: `@`(vk: VkRef; event, body: untyped): untyped

`type`:

• button: `type`(btn: ButtonObj): string

`~`:

• compiletime: `~`(vk, body: untyped): untyped

addButton:

• keyboard: addButton(kb: KeyboardRef; btn: ButtonObj)
• template_elem: addButton(elem: var TElementObj; btn: ButtonObj)

addElement:

• template_vk: addElement(t: TemplateRef; elem: TElementObj)

addLine:

• keyboard: addLine(kb: KeyboardRef)

audio:

• uploader: audio(upl: UploaderRef; files: seq[string]; artist: string = ""; title: string = ""): Future[string]

BOT_LONGPOLL_URL:

• consts: BOT_LONGPOLL_URL

ButtonAction:

• enums: ButtonAction

ButtonApp:

• ButtonAction.ButtonApp

ButtonCallback:

• ButtonAction.ButtonCallback

ButtonColor:

• enums: ButtonColor

ButtonLink:

• ButtonAction.ButtonLink

ButtonLocation:

• ButtonAction.ButtonLocation

ButtonObj:

• button: ButtonObj

ButtonPay:

• ButtonAction.ButtonPay

ButtonText:

• ButtonAction.ButtonText

callVkMethod:

• vk: callVkMethod(vk: VkRef; method_name: string; params: JsonNode = %*{}): Future[ JsonNode]

close:

• longpoll: close(lp: LongpollRef)

ColorNegative:

• ButtonColor.ColorNegative

ColorPositive:

• ButtonColor.ColorPositive

ColorPrimary:

• ButtonColor.ColorPrimary

ColorSecondary:

• ButtonColor.ColorSecondary

DEFAULT_VK_API:

• consts: DEFAULT_VK_API

description:

• template_elem: description(elem: TElementObj): string

description=:

• template_elem: description=(elem: var TElementObj; val: string)

doc:

• uploader: doc(upl: UploaderRef; files: seq[string]; group_id: int = 0; title: string = ""; tags: string = ""; return_tags: int = 0; is_wall: bool = false): Future[ string]

docMessage:

• uploader: docMessage(upl: UploaderRef; files: seq[string]; peer_id: int; doc_type = "doc"; title = ""; tags = ""; return_tags = 0): Future[string]

format:

• uploader: format(response: JsonNode; response_type = "photo"): string

getAttachId:

• uploader: getAttachId(formatted: string): string

getInfo:

• uploader: getInfo(formatted: string): seq[(string, string, string)]

hash:

• button: hash(btn: ButtonObj): string

hash=:

• button: hash=(btn: var ButtonObj; value: string)

inline:

• keyboard: inline(kb: KeyboardRef): bool

inline=:

• keyboard: inline=(kb: KeyboardRef; val: bool)

KeyboardError:

• exceptions: KeyboardError

KeyboardRef:

• keyboard: KeyboardRef

label:

• button: label(btn: ButtonObj): string

label=:

• button: label=(btn: var ButtonObj; value: string)

link:

• template_elem: link(elem: TElementObj): string

link=:

• template_elem: link=(elem: var TElementObj; val: string)

listen:

• longpoll: listen(lp: LongpollRef): JsonNode

login:

• tools: login(client: AsyncHttpClient; login: SomeInteger; password: string; version: string = DEFAULT_VK_API; tfcode: string = ""; scope: string = "all"): Future[string]

LongpollError:

• exceptions: LongpollError

LongpollRef:

• longpoll: LongpollRef

METHOD_VK_API_URL:

• consts: METHOD_VK_API_URL

newButton:

• button: newButton(action: ButtonAction = ButtonText; color: ButtonColor = ColorPrimary): ButtonObj

newGroupVk:

• vk: newGroupVk(access_token: string; group_id: uint; api_version: string = DEFAULT_VK_API): VkRef

newKeyboard:

• keyboard: newKeyboard(inline: bool = true; one_time: bool = false): KeyboardRef

newLongpoll:

• longpoll: newLongpoll(vk: VkRef): LongpollRef

newTElement:

• template_elem: newTElement(title: string; description: string; photo_id: string; buttons: JsonNode = newJArray(); action: TElementAction = TElementPhoto): TElementObj

newTemplate:

• template_vk: newTemplate(type: string = "carousel"; elements: JsonNode = newJArray()): TemplateRef

newUploader:

• uploader: newUploader(vk: VkRef): UploaderRef

newUserVk:

• vk: newUserVk(userlogin: int; password: string; api_version: string = DEFAULT_VK_API): VkRef

newVk:

• vk: newVk(userlogin: int; password: string; api_version: string = DEFAULT_VK_API): VkRef
• vk: newVk(access_token: string; api_version: string = DEFAULT_VK_API): VkRef
• vk: newVk(access_token: string; group_id: uint; api_version: string = DEFAULT_VK_API): VkRef

one_time:

• keyboard: one_time(kb: KeyboardRef): bool

one_time=:

• keyboard: one_time=(kb: KeyboardRef; val: bool)

parseEvent:

• user_event: parseEvent(arr: JsonNode): JsonNode

photoAlbum:

• uploader: photoAlbum(upl: UploaderRef; files: seq[string]; album_id: int; group_id: uint = 0; caption: string = ""): Future[string]

photoChat:

• uploader: photoChat(upl: UploaderRef; files: seq[string]; chat_id: int; crop_x: int = 0; crop_y: int = 0; crop_width: int = 0): Future[string]

photoCover:

• uploader: photoCover(upl: UploaderRef; files: seq[string]; group_id: int; crop_x: int = 0; crop_y: int = 0; crop_x2: int = 795; crop_y2: int = 200): Future[ string]

photo_id:

• template_elem: photo_id(elem: TElementObj): string

photo_id=:

• template_elem: photo_id=(elem: var TElementObj; val: string)

photoMessage:

• uploader: photoMessage(upl: UploaderRef; files: seq[string]; peer_id: int): Future[string]

photoProfile:

• uploader: photoProfile(upl: UploaderRef; file: string; owner_id: int = 0): Future[string]

photoWall:

• uploader: photoWall(upl: UploaderRef; files: seq[string]; group_id: int = 0; user_id: int = 0; caption: string = ""): Future[string]

run:

• longpoll: run(lp: LongpollRef): owned(Future[void])

TElementAction:

• enums: TElementAction

TElementLink:

• TElementAction.TElementLink

TElementObj:

• template_elem: TElementObj

TElementPhoto:

• TElementAction.TElementPhoto

TemplateError:

• exceptions: TemplateError

throw:

• exceptions: throw(err: typedesc; msg: string)

title:

• template_elem: title(elem: TElementObj): string

title=:

• template_elem: title=(elem: var TElementObj; val: string)

toJson:

• button: toJson(btn: ButtonObj): JsonNode
• keyboard: toJson(kb: KeyboardRef): JsonNode
• template_elem: toJson(elem: TElementObj): JsonNode
• template_vk: toJson(t: TemplateRef): JsonNode

UploaderRef:

• uploader: UploaderRef

USER_LONGPOLL_URL:

• consts: USER_LONGPOLL_URL

VK_API_URL:

• consts: VK_API_URL

VkError:

• exceptions: VkError

VkEvent:

• vk: VkEvent

VkGroup:

• VkKind.VkGroup

VkKind:

• enums: VkKind

VkRef:

• vk: VkRef

VkUser:

• VkKind.VkUser