2sucres-api
Last updated 2 years ago by taigah.dev .
MIT · Original npm · Tarball · package.json
$ cnpm install 2sucres-api 
SYNC missed versions from official npm registry.

2sucres-api

Installation

yarn add 2sucres-api

Utilisation

const apiFactory = require('2sucres-api')
const api = apiFactory(cookies, csrfToken)

const TOPIC_ID = 1
const MESSAGE_ID = 1

/**
 * Récupère le nombre de messages d'un topic
 * et l'indique dans le message original du topic
 */
async function run () {
  const topic = await api.getTopic(TOPIC_ID)
  const messageCount = topic.messageCount
  await message.editMessage(MESSAGE_ID, `Le topic contient ${messageCount} message(s)`)
}

run().catch(err => {
  // global error handling
  throw err
})

API

Functions

clearNotifications()

Supprime les notifications

deleteTopic(topicId)

Supprime un topic

editMessage(messageId, content)

Édite un message

getMessage(messageId)message

Récupère les informations d'un message par son id

getMessages(topicId, page)Array.<message>

Retourne la liste des messages d'une page d'un topic

getNotifications(clear)

Récupère la liste des notifications

getTopicEnd(topicId)

Récupère la fin du topic

getTopic(topicId, page)topic

Récupère les informations d'un topic

getTopics(page, forumId)Array.<topic>

Récupère la liste des topics

lockTopic(topicId)

Lock un topic

postMessage(topicId, content)

Poste un message

postTopic(title, content, options)

Poste un topic

unlockTopic(topicId)

Délock un topic

updateTitle(topicId, title)

Met à jour le titre d'un topic

clearNotifications()

Supprime les notifications

Kind: global function

deleteTopic(topicId)

Supprime un topic

Kind: global function

Param Type
topicId number

editMessage(messageId, content)

Édite un message

Kind: global function

Param Type
messageId number
content string

getMessage(messageId) ⇒ message

Récupère les informations d'un message par son id

Kind: global function

Param Type
messageId number

getMessages(topicId, page) ⇒ Array.<message>

Retourne la liste des messages d'une page d'un topic

Kind: global function

Param Type Default
topicId number
page number 1

getNotifications(clear)

Récupère la liste des notifications

Kind: global function

Param Type Default Description
clear boolean false si vrai, supprime les notifications après les avoir récupérées

getTopicEnd(topicId)

Récupère la fin du topic

Kind: global function

Param Type
topicId number

getTopic(topicId, page) ⇒ topic

Récupère les informations d'un topic

Kind: global function

Param Type Default
topicId number
page number 1

getTopics(page, forumId) ⇒ Array.<topic>

Récupère la liste des topics

Kind: global function

Param Type Default
page number 1
forumId number 1

lockTopic(topicId)

Lock un topic

Kind: global function

Param Type
topicId number

postMessage(topicId, content)

Poste un message

Kind: global function

Param Type
topicId number
content string

postTopic(title, content, options)

Poste un topic

Kind: global function

Param Type
title string
content string
options object

unlockTopic(topicId)

Délock un topic

Kind: global function

Param Type
topicId number

updateTitle(topicId, title)

Met à jour le titre d'un topic

Kind: global function

Param Type
topicId number
title string

Current Tags

  • 1.1.1                                ...           latest (2 years ago)

8 Versions

  • 1.1.1                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.3                                ...           2 years ago
  • 1.0.2                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
  • 0.0.2                                ...           2 years ago
  • 0.0.1                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 8
This Month 16
Last Day 8
Last Week 8
Last Month 20
Dependencies (3)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |