pidgin/pidgin

Add some new methods to purple tags
default tip
21 hours ago, Gary Kramlich
b45add2a840c
Add some new methods to purple tags

* purple_tags_exists is a simplier version of purple_tags_lookup.
* purple_tags_contains makes it easier to find multiple matching tags.

Testing Done:
Ran the unit tests under valgrind and had the turtles check in on things too.

Reviewed at https://reviews.imfreedom.org/r/3143/
/*
* Purple - Internet Messaging Library
* Copyright (C) Pidgin Developers <devel@pidgin.im>
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This library 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 library 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 library; if not, see <https://www.gnu.org/licenses/>.
*/
#if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
# error "only <purple.h> may be included directly"
#endif
#ifndef PURPLE_PROTOCOL_MEDIA_H
#define PURPLE_PROTOCOL_MEDIA_H
#include <glib.h>
#include <glib-object.h>
#include "media.h"
#include "purpleaccount.h"
#include "purpleprotocol.h"
#include "purpleversion.h"
#define PURPLE_TYPE_PROTOCOL_MEDIA (purple_protocol_media_get_type())
PURPLE_AVAILABLE_IN_3_0
G_DECLARE_INTERFACE(PurpleProtocolMedia, purple_protocol_media, PURPLE,
PROTOCOL_MEDIA, PurpleProtocol)
G_BEGIN_DECLS
/**
* PurpleProtocolMedia:
*
* #PurpleProtocolMedia describes the multimedia api that is available for
* protocols.
*
* Since: 3.0
*/
struct _PurpleProtocolMediaInterface {
/*< private >*/
GTypeInterface parent;
/*< public >*/
gboolean (*initiate_session)(PurpleProtocolMedia *media, PurpleAccount *account, const gchar *who, PurpleMediaSessionType type);
PurpleMediaCaps (*get_caps)(PurpleProtocolMedia *media, PurpleAccount *account, const gchar *who);
gboolean (*send_dtmf)(PurpleProtocolMedia *protocol_media, PurpleMedia *media, gchar dtmf, guint8 volume, guint8 duration);
/*< private >*/
gpointer reserved[4];
};
/**
* purple_protocol_media_initiate_session:
* @media: The #PurpleProtocolMedia instance.
* @account: The #PurpleAccount instance.
* @who: The user to initiate a media session with.
* @type: The type of media session to create.
*
* Initiates a media connection of @type to @who.
*
* Returns: %TRUE if successful, %FALSE otherwise.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
gboolean purple_protocol_media_initiate_session(PurpleProtocolMedia *media, PurpleAccount *account, const gchar *who, PurpleMediaSessionType type);
/**
* purple_protocol_media_get_caps:
* @media: The #PurpleProtocolMedia instance.
* @account: The #PurpleAccount instance.
* @who: The user to get the media capabilities for.
*
* Gets the #PurpleMediaCaps for @who which determine what types of media are
* available.
*
* Returns: the media capabilities of @who.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
PurpleMediaCaps purple_protocol_media_get_caps(PurpleProtocolMedia *media, PurpleAccount *account, const gchar *who);
/**
* purple_protocol_media_send_dtmf:
* @protocol_media: The #PurpleProtocolMedia instance.
* @media: The #PurpleMedia instance.
* @dtmf: A DTMF to send.
* @volume: The volume to send @dtmf at.
* @duration: The duration to send @dtmf (in ms?)
*
* Sends a DTMF (dual-tone multi-frequency) signal via the established @media
* for the given @duration at the given @volume.
*
* It is up to the specific implementation if DTMF is send in or out of band.
*
* Returns: %TRUE if successful, %FALSE otherwise.
*
* Since: 3.0
*/
PURPLE_AVAILABLE_IN_3_0
gboolean purple_protocol_media_send_dtmf(PurpleProtocolMedia *protocol_media, PurpleMedia *media, gchar dtmf, guint8 volume, guint8 duration);
G_END_DECLS
#endif /* PURPLE_PROTOCOL_MEDIA_H */