mirror of
https://github.com/processone/ejabberd.git
synced 2024-12-22 17:28:25 +01:00
103 lines
2.9 KiB
Erlang
103 lines
2.9 KiB
Erlang
%%%----------------------------------------------------------------------
|
|
%%% File : gen_pubsub_nodetree.erl
|
|
%%% Author : Christophe Romain <christophe.romain@process-one.net>
|
|
%%% Purpose : Define the pubsub node tree plugin behaviour
|
|
%%% Created : 1 Dec 2007 by Christophe Romain <christophe.romain@process-one.net>
|
|
%%%
|
|
%%%
|
|
%%% ejabberd, Copyright (C) 2002-2016 ProcessOne
|
|
%%%
|
|
%%% This program is free software; you can redistribute it and/or
|
|
%%% modify it under the terms of the GNU General Public License as
|
|
%%% published by the Free Software Foundation; either version 2 of the
|
|
%%% License, or (at your option) any later version.
|
|
%%%
|
|
%%% This program is distributed in the hope that it will be useful,
|
|
%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
%%% General Public License for more details.
|
|
%%%
|
|
%%% You should have received a copy of the GNU General Public License along
|
|
%%% with this program; if not, write to the Free Software Foundation, Inc.,
|
|
%%% 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
%%%
|
|
%%%----------------------------------------------------------------------
|
|
|
|
-module(gen_pubsub_nodetree).
|
|
|
|
-include("jlib.hrl").
|
|
|
|
-type(host() :: mod_pubsub:host()).
|
|
-type(nodeId() :: mod_pubsub:nodeId()).
|
|
-type(nodeIdx() :: mod_pubsub:nodeIdx()).
|
|
-type(pubsubNode() :: mod_pubsub:pubsubNode()).
|
|
-type(nodeOptions() :: mod_pubsub:nodeOptions()).
|
|
|
|
-callback init(Host :: host(),
|
|
ServerHost :: binary(),
|
|
Opts :: [any()]) -> atom().
|
|
|
|
-callback terminate(Host :: host(), ServerHost :: binary()) -> atom().
|
|
|
|
-callback options() -> nodeOptions().
|
|
|
|
-callback set_node(PubsubNode :: pubsubNode()) ->
|
|
ok | {result, NodeIdx::nodeIdx()} | {error, xmlel()}.
|
|
|
|
-callback get_node(Host :: host(),
|
|
NodeId :: nodeId(),
|
|
From :: jid()) ->
|
|
pubsubNode() |
|
|
{error, xmlel()}.
|
|
|
|
-callback get_node(Host :: host(),
|
|
NodeId :: nodeId()) ->
|
|
pubsubNode() |
|
|
{error, xmlel()}.
|
|
|
|
-callback get_node(NodeIdx :: nodeIdx()) ->
|
|
pubsubNode() |
|
|
{error, xmlel()}.
|
|
|
|
-callback get_nodes(Host :: host(),
|
|
From :: jid())->
|
|
[pubsubNode()].
|
|
|
|
-callback get_nodes(Host :: host())->
|
|
[pubsubNode()].
|
|
|
|
-callback get_parentnodes(Host :: host(),
|
|
NodeId :: nodeId(),
|
|
From :: jid()) ->
|
|
[pubsubNode()] |
|
|
{error, xmlel()}.
|
|
|
|
-callback get_parentnodes_tree(Host :: host(),
|
|
NodeId :: nodeId(),
|
|
From :: jid()) ->
|
|
[{0, [pubsubNode(),...]}].
|
|
|
|
-callback get_subnodes(Host :: host(),
|
|
NodeId :: nodeId(),
|
|
From :: jid()) ->
|
|
[pubsubNode()].
|
|
|
|
-callback get_subnodes_tree(Host :: host(),
|
|
NodeId :: nodeId(),
|
|
From :: jid()) ->
|
|
[pubsubNode()].
|
|
|
|
-callback create_node(Host :: host(),
|
|
NodeId :: nodeId(),
|
|
Type :: binary(),
|
|
Owner :: jid(),
|
|
Options :: nodeOptions(),
|
|
Parents :: [nodeId()]) ->
|
|
{ok, NodeIdx::nodeIdx()} |
|
|
{error, xmlel()} |
|
|
{error, {virtual, {host(), nodeId()}}}.
|
|
|
|
-callback delete_node(Host :: host(),
|
|
NodeId :: nodeId()) ->
|
|
[pubsubNode()].
|