summaryrefslogtreecommitdiffstats
path: root/pttpi
diff options
context:
space:
mode:
authorin2 <in2@63ad8ddf-47c3-0310-b6dd-a9e9d9715204>2003-05-19 09:21:43 +0800
committerin2 <in2@63ad8ddf-47c3-0310-b6dd-a9e9d9715204>2003-05-19 09:21:43 +0800
commit242ccc3bd1a4670d4dd969d20dd1b41731e94899 (patch)
treeb85ba3d02dfd05f55ec89717ddcca401b658c41a /pttpi
parentbc0a07494d4596a7076b233cd1945306c9838c1a (diff)
downloadpttbbs-242ccc3bd1a4670d4dd969d20dd1b41731e94899.tar
pttbbs-242ccc3bd1a4670d4dd969d20dd1b41731e94899.tar.gz
pttbbs-242ccc3bd1a4670d4dd969d20dd1b41731e94899.tar.bz2
pttbbs-242ccc3bd1a4670d4dd969d20dd1b41731e94899.tar.lz
pttbbs-242ccc3bd1a4670d4dd969d20dd1b41731e94899.tar.xz
pttbbs-242ccc3bd1a4670d4dd969d20dd1b41731e94899.tar.zst
pttbbs-242ccc3bd1a4670d4dd969d20dd1b41731e94899.zip
*** empty log message ***
git-svn-id: http://opensvn.csie.org/pttbbs/pttbbs/trunk/pttbbs@867 63ad8ddf-47c3-0310-b6dd-a9e9d9715204
Diffstat (limited to 'pttpi')
-rw-r--r--pttpi/README4
-rw-r--r--pttpi/doc/spec50
2 files changed, 54 insertions, 0 deletions
diff --git a/pttpi/README b/pttpi/README
new file mode 100644
index 00000000..8f60ff6c
--- /dev/null
+++ b/pttpi/README
@@ -0,0 +1,4 @@
+PTT Programming Interface
+
+這目前還是一個實驗性的東西,
+它還不穩定, 沒有效率, 沒有經過完整測試, 並且 spec 還在編修中.
diff --git a/pttpi/doc/spec b/pttpi/doc/spec
new file mode 100644
index 00000000..e1460030
--- /dev/null
+++ b/pttpi/doc/spec
@@ -0,0 +1,50 @@
+board.getBid get bid from board name
+input (s)
+ (board name)
+output ({s:i, s:s, s:i})
+ {errno => errno,
+ brdname => boardname,
+ bid => boardid} (bid = -1 if error)
+
+
+board.getBrdInfo
+get board information (by bid)
+input (i)
+ (bid)
+output ({s:i,s:s,s:i,s:6,s:6,s:i})
+ {errno => errno,
+ brdname => boardname
+ bid => bid,
+ title => title (Base64),
+ BM => board manager(s) (Base64),
+ nuser => #users in this board,
+ }
+
+board.getNarticle
+get # articles in the board
+input (i)
+ (bid)
+output ({s:i, s:s, s:i})
+ {errno => errno,
+ narticle => #articles in the board}
+
+article.list
+get article list of bid
+input (ii)
+ (bid, from # article)
+output: ({s:i,s:s,s:i,s:s,s:s,s:6}...)
+ [{articleid => article id,
+ filename => file name,
+ recommend => recommend,
+ owner => owner's userid,
+ date => date (format: mm/dd),
+ title => article title (Base64)},
+ {...},...]
+
+article.readfn
+read article by bid and filename
+input (is)
+ (bid, filename)
+output ({s:6})
+ {content => content}
+