2023-03-04 15:25:22 +00:00
<!doctype html>
2023-11-05 06:58:16 +00:00
< html class = "no-js" >
2023-03-04 15:25:22 +00:00
< head >
< meta name = "viewport" content = "width=device-width, initial-scale=1" charset = "UTF-8" >
< title > PinChatMessage< / title >
2023-11-05 06:58:16 +00:00
< link href = "../../../images/logo-icon.svg" rel = "icon" type = "image/svg" > < script > var pathToRoot = "../../../" ; < / script >
< script > document . documentElement . classList . replace ( "no-js" , "js" ) ; < / script >
< script > c o n s t s t o r a g e = l o c a l S t o r a g e . g e t I t e m ( " d o k k a - d a r k - m o d e " )
2023-03-04 15:25:22 +00:00
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia & & window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if(savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
< / script >
2023-11-05 06:58:16 +00:00
< script type = "text/javascript" src = "https://unpkg.com/kotlin-playground@1/dist/playground.min.js" async > < / script >
2023-03-04 15:25:22 +00:00
< script type = "text/javascript" src = "../../../scripts/sourceset_dependencies.js" async > < / script >
< link href = "../../../styles/style.css" rel = "Stylesheet" >
< link href = "../../../styles/main.css" rel = "Stylesheet" >
< link href = "../../../styles/prism.css" rel = "Stylesheet" >
< link href = "../../../styles/logo-styles.css" rel = "Stylesheet" >
2023-11-05 06:58:16 +00:00
< link href = "../../../styles/font-jb-sans-auto.css" rel = "Stylesheet" >
2023-03-04 15:25:22 +00:00
< script type = "text/javascript" src = "../../../scripts/clipboard.js" async > < / script >
< script type = "text/javascript" src = "../../../scripts/navigation-loader.js" async > < / script >
< script type = "text/javascript" src = "../../../scripts/platform-content-handler.js" async > < / script >
< script type = "text/javascript" src = "../../../scripts/main.js" defer > < / script >
< script type = "text/javascript" src = "../../../scripts/prism.js" async > < / script >
< script type = "text/javascript" src = "../../../scripts/symbol-parameters-wrapper_deferred.js" defer > < / script > < / head >
< body >
2023-11-05 06:58:16 +00:00
< div class = "root" >
< nav class = "navigation" id = "navigation-wrapper" >
< div class = "navigation--inner" >
< div class = "navigation-title" >
< button class = "menu-toggle" id = "menu-toggle" type = "button" > toggle menu< / button >
< div class = "library-name" >
< a class = "library-name--link" href = "../../../index.html" >
ktgbotapi
< / a > < / div >
< div class = "library-version" >
< / div >
< / div >
2023-03-04 15:25:22 +00:00
< div class = "filter-section" id = "filter-section" >
< button class = "platform-tag platform-selector common-like" data-active = "" data-filter = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > common< / button >
< / div >
< / div >
2023-11-05 06:58:16 +00:00
< div class = "navigation-controls" >
< button class = "navigation-controls--btn navigation-controls--theme" id = "theme-toggle-button" type = "button" > switch theme< / button >
< div class = "navigation-controls--btn navigation-controls--search" id = "searchBar" role = "button" > search in API< / div >
2023-03-04 15:25:22 +00:00
< / div >
2023-11-05 06:58:16 +00:00
< / nav >
< div id = "container" >
< div class = "sidebar" id = "leftColumn" >
< div class = "sidebar--inner" id = "sideMenu" > < / div >
< / div >
< div id = "main" >
2023-03-04 15:25:22 +00:00
< div class = "main-content" data-page-type = "classlike" id = "content" pageids = "tgbotapi.core::dev.inmo.tgbotapi.requests.chat.modify/PinChatMessage///PointingToDeclaration//789214110" >
< div class = "breadcrumbs" > < a href = "../../index.html" > tgbotapi.core< / a > < span class = "delimiter" > /< / span > < a href = "../index.html" > dev.inmo.tgbotapi.requests.chat.modify< / a > < span class = "delimiter" > /< / span > < span class = "current" > PinChatMessage< / span > < / div >
< div class = "cover " >
< h1 class = "cover" > < span > Pin< / span > < wbr > < span > Chat< / span > < wbr > < span > < span > Message< / span > < / span > < / h1 >
2023-11-05 06:58:16 +00:00
< div class = "platform-hinted " data-platform-hinted = "data-platform-hinted" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < div class = "block" > < div class = "block" > < span class = "token annotation builtin" > @< / span > < span data-unresolved-link = "kotlinx.serialization/Serializable///PointingToDeclaration/" > < span class = "token annotation builtin" > Serializable< / span > < / span > < / div > < / div > < span class = "token keyword" > data < / span > < span class = "token keyword" > class < / span > < a href = "index.html" > PinChatMessage< / a > < span class = "token punctuation" > (< / span > < span class = "parameters " > < span class = "parameter " > < span class = "token keyword" > val < / span > chatId< span class = "token operator" > : < / span > < a href = "../../dev.inmo.tgbotapi.types/-chat-identifier/index.html" > ChatIdentifier< / a > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > < span class = "token keyword" > val < / span > messageId< span class = "token operator" > : < / span > < a href = "../../dev.inmo.tgbotapi.types/-message-id/index.html" > MessageId< / a > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > < span class = "token keyword" > val < / span > disableNotification< span class = "token operator" > : < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html" > Boolean< / a > < span class = "token operator" > = < / span > < span class = "token boolean" > false< / span > < / span > < / span > < span class = "token punctuation" > )< / span > : < a href = "../../dev.inmo.tgbotapi.abstracts.types/-chat-request/index.html" > ChatRequest< / a > , < a href = "../../dev.inmo.tgbotapi.requests.abstracts/-simple-request/index.html" > SimpleRequest< / a > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html" > Boolean< / a > < span class = "token operator" > > < / span > , < a href = "../../dev.inmo.tgbotapi.abstracts.types/-message-action/index.html" > MessageAction< / a > , < a href = "../../dev.inmo.tgbotapi.abstracts.types/-disable-notification/index.html" > DisableNotification< / a > < / div > < p class = "paragraph" > Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' admin right in a supergroup or 'can_edit_messages' admin right in a channel.< / p > < / div > < / div >
2023-03-04 15:25:22 +00:00
< / div >
< div class = "tabbedcontent" >
2023-06-09 06:14:58 +00:00
< div class = "tabs-section" tabs-section = "tabs-section" > < button class = "section-tab" data-active = "" data-togglable = "CONSTRUCTOR,TYPE,PROPERTY,FUNCTION" > Members< / button > < / div >
2023-03-04 15:25:22 +00:00
< div class = "tabs-section-body" >
< div data-togglable = "CONSTRUCTOR" >
< h2 class = "" > Constructors< / h2 >
< div class = "table" > < a data-name = "-148806051%2FConstructors%2F789214110" anchor-label = "PinChatMessage" id = "-148806051%2FConstructors%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-togglable = "CONSTRUCTOR" data-filterable-current = ":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "-pin-chat-message.html" > < span > Pin< / span > < wbr > < span > Chat< / span > < wbr > < span > < span > Message< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-148806051%2FConstructors%2F789214110" > < / span >
< div class = "copy-popup-wrapper " > < span class = "copy-popup-icon" > < / span > < span > Link copied to clipboard< / span > < / div >
< / span > < / span > < / div >
< div >
< div class = "title" >
2023-11-05 06:58:16 +00:00
< div class = "platform-hinted " data-platform-hinted = "data-platform-hinted" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > constructor< / span > < span class = "token punctuation" > (< / span > < span class = "parameters " > < span class = "parameter " > chatId< span class = "token operator" > : < / span > < a href = "../../dev.inmo.tgbotapi.types/-chat-identifier/index.html" > ChatIdentifier< / a > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > messageId< span class = "token operator" > : < / span > < a href = "../../dev.inmo.tgbotapi.types/-message-id/index.html" > MessageId< / a > < span class = "token punctuation" > , < / span > < / span > < span class = "parameter " > disableNotification< span class = "token operator" > : < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html" > Boolean< / a > < span class = "token operator" > = < / span > < span class = "token boolean" > false< / span > < / span > < / span > < span class = "token punctuation" > )< / span > < / div > < / div > < / div >
2023-03-04 15:25:22 +00:00
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< div data-togglable = "PROPERTY" >
< h2 class = "" > Properties< / h2 >
< div class = "table" > < a data-name = "-1128192956%2FProperties%2F789214110" anchor-label = "chatId" id = "-1128192956%2FProperties%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-filterable-current = ":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "chat-id.html" > < span > chat< / span > < wbr > < span > < span > Id< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1128192956%2FProperties%2F789214110" > < / span >
< div class = "copy-popup-wrapper " > < span class = "copy-popup-icon" > < / span > < span > Link copied to clipboard< / span > < / div >
< / span > < / span > < / div >
< div >
< div class = "title" >
2023-11-05 06:58:16 +00:00
< div class = "platform-hinted " data-platform-hinted = "data-platform-hinted" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < div class = "block" > < div class = "block" > < span class = "token annotation builtin" > @< / span > < span data-unresolved-link = "kotlinx.serialization/SerialName///PointingToDeclaration/" > < span class = "token annotation builtin" > SerialName< / span > < / span > < span class = "token punctuation" > (< / span > < span > value< span class = "token operator" > = < / span > < span class = "breakable-word" > < span class = "token string" > "chat_id"< / span > < / span > < / span > < wbr > < span class = "token punctuation" > )< / span > < / div > < / div > < span class = "token keyword" > open < / span > < span class = "token keyword" > override < / span > < span class = "token keyword" > val < / span > < a href = "chat-id.html" > chatId< / a > < span class = "token operator" > : < / span > < a href = "../../dev.inmo.tgbotapi.types/-chat-identifier/index.html" > ChatIdentifier< / a > < / div > < / div > < / div >
2023-03-04 15:25:22 +00:00
< / div >
< / div >
< / div >
< / div >
< a data-name = "1119566256%2FProperties%2F789214110" anchor-label = "disableNotification" id = "1119566256%2FProperties%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-filterable-current = ":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "disable-notification.html" > < span > disable< / span > < wbr > < span > < span > Notification< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "1119566256%2FProperties%2F789214110" > < / span >
< div class = "copy-popup-wrapper " > < span class = "copy-popup-icon" > < / span > < span > Link copied to clipboard< / span > < / div >
< / span > < / span > < / div >
< div >
< div class = "title" >
2023-11-05 06:58:16 +00:00
< div class = "platform-hinted " data-platform-hinted = "data-platform-hinted" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < div class = "block" > < div class = "block" > < span class = "token annotation builtin" > @< / span > < span data-unresolved-link = "kotlinx.serialization/SerialName///PointingToDeclaration/" > < span class = "token annotation builtin" > SerialName< / span > < / span > < span class = "token punctuation" > (< / span > < span > value< span class = "token operator" > = < / span > < span class = "breakable-word" > < span class = "token string" > "disable_notification"< / span > < / span > < / span > < wbr > < span class = "token punctuation" > )< / span > < / div > < / div > < span class = "token keyword" > open < / span > < span class = "token keyword" > override < / span > < span class = "token keyword" > val < / span > < a href = "disable-notification.html" > disableNotification< / a > < span class = "token operator" > : < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html" > Boolean< / a > < span class = "token operator" > = < / span > < span class = "token boolean" > false< / span > < / div > < / div > < / div >
2023-03-04 15:25:22 +00:00
< / div >
< / div >
< / div >
< / div >
< a data-name = "-192440191%2FProperties%2F789214110" anchor-label = "messageId" id = "-192440191%2FProperties%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-filterable-current = ":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "message-id.html" > < span > message< / span > < wbr > < span > < span > Id< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-192440191%2FProperties%2F789214110" > < / span >
< div class = "copy-popup-wrapper " > < span class = "copy-popup-icon" > < / span > < span > Link copied to clipboard< / span > < / div >
< / span > < / span > < / div >
< div >
< div class = "title" >
2023-11-05 06:58:16 +00:00
< div class = "platform-hinted " data-platform-hinted = "data-platform-hinted" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < div class = "block" > < div class = "block" > < span class = "token annotation builtin" > @< / span > < span data-unresolved-link = "kotlinx.serialization/SerialName///PointingToDeclaration/" > < span class = "token annotation builtin" > SerialName< / span > < / span > < span class = "token punctuation" > (< / span > < span > value< span class = "token operator" > = < / span > < span class = "breakable-word" > < span class = "token string" > "message_id"< / span > < / span > < / span > < wbr > < span class = "token punctuation" > )< / span > < / div > < / div > < span class = "token keyword" > open < / span > < span class = "token keyword" > override < / span > < span class = "token keyword" > val < / span > < a href = "message-id.html" > messageId< / a > < span class = "token operator" > : < / span > < a href = "../../dev.inmo.tgbotapi.types/-message-id/index.html" > MessageId< / a > < / div > < / div > < / div >
2023-03-04 15:25:22 +00:00
< / div >
< / div >
< / div >
< / div >
< a data-name = "1593419106%2FProperties%2F789214110" anchor-label = "requestSerializer" id = "1593419106%2FProperties%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-filterable-current = ":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "request-serializer.html" > < span > request< / span > < wbr > < span > < span > Serializer< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "1593419106%2FProperties%2F789214110" > < / span >
< div class = "copy-popup-wrapper " > < span class = "copy-popup-icon" > < / span > < span > Link copied to clipboard< / span > < / div >
< / span > < / span > < / div >
< div >
< div class = "title" >
< div class = "platform-hinted " data-platform-hinted = "data-platform-hinted" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > open < / span > < span class = "token keyword" > override < / span > < span class = "token keyword" > val < / span > < a href = "request-serializer.html" > requestSerializer< / a > < span class = "token operator" > : < / span > < span data-unresolved-link = "kotlinx.serialization/SerializationStrategy///PointingToDeclaration/" > SerializationStrategy< / span > < span class = "token operator" > < < / span > < span class = "token operator" > *< / span > < span class = "token operator" > > < / span > < / div > < / div > < / div >
< / div >
< / div >
< / div >
< / div >
< a data-name = "-1151009561%2FProperties%2F789214110" anchor-label = "resultDeserializer" id = "-1151009561%2FProperties%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-filterable-current = ":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "result-deserializer.html" > < span > result< / span > < wbr > < span > < span > Deserializer< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-1151009561%2FProperties%2F789214110" > < / span >
< div class = "copy-popup-wrapper " > < span class = "copy-popup-icon" > < / span > < span > Link copied to clipboard< / span > < / div >
< / span > < / span > < / div >
< div >
< div class = "title" >
< div class = "platform-hinted " data-platform-hinted = "data-platform-hinted" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > open < / span > < span class = "token keyword" > override < / span > < span class = "token keyword" > val < / span > < a href = "result-deserializer.html" > resultDeserializer< / a > < span class = "token operator" > : < / span > < span data-unresolved-link = "kotlinx.serialization/DeserializationStrategy///PointingToDeclaration/" > DeserializationStrategy< / span > < span class = "token operator" > < < / span > < span class = "token keyword" > < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html" > Boolean< / a > < span class = "token operator" > > < / span > < / div > < / div > < / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
2023-06-09 06:14:58 +00:00
< div data-togglable = "FUNCTION" >
< h2 class = "" > Functions< / h2 >
< div class = "table" > < a data-name = "-721613386%2FFunctions%2F789214110" anchor-label = "method" id = "-721613386%2FFunctions%2F789214110" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < / a >
< div class = "table-row" data-filterable-current = ":tgbotapi.core:dokkaHtmlPartial/commonMain" data-filterable-set = ":tgbotapi.core:dokkaHtmlPartial/commonMain" >
< div class = "main-subrow keyValue " >
< div class = "" > < span class = "inline-flex" >
< div > < a href = "method.html" > < span > < span > method< / span > < / span > < / a > < / div >
< span class = "anchor-wrapper" > < span class = "anchor-icon" pointing-to = "-721613386%2FFunctions%2F789214110" > < / span >
< div class = "copy-popup-wrapper " > < span class = "copy-popup-icon" > < / span > < span > Link copied to clipboard< / span > < / div >
< / span > < / span > < / div >
< div >
< div class = "title" >
< div class = "platform-hinted " data-platform-hinted = "data-platform-hinted" > < div class = "content sourceset-dependent-content" data-active = "" data-togglable = ":tgbotapi.core:dokkaHtmlPartial/commonMain" > < div class = "symbol monospace" > < span class = "token keyword" > open < / span > < span class = "token keyword" > override < / span > < span class = "token keyword" > fun < / span > < a href = "method.html" > < span class = "token function" > method< / span > < / a > < span class = "token punctuation" > (< / span > < span class = "token punctuation" > )< / span > < span class = "token operator" > : < / span > < a href = "https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html" > String< / a > < / div > < / div > < / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< / div >
2023-03-04 15:25:22 +00:00
< / div >
< / div >
< / div >
< div class = "footer" >
< span class = "go-to-top-icon" > < a href = "#content" id = "go-to-top-link" > < / a > < / span > < span > © 2023 Copyright< / span > < span class = "pull-right" > < span > Generated by < / span > < a href = "https://github.com/Kotlin/dokka" > < span > dokka< / span > < span class = "padded-icon" > < / span > < / a > < / span >
< / div >
2023-11-05 06:58:16 +00:00
< / div >
< / div >
2023-03-04 15:25:22 +00:00
< / div >
< / body >
< / html >
