Strona główna > Poradniki > Atrybuty wtyczki

Poradniki - Atrybuty wtyczki

Każda wtyczka posiada kilka podstawowych atrybutów, które ją opisują. Przedstawię je tutaj i opiszę jak je stosować

Wartość ID

Wartość ta jest wymyślona przeze mnie i ma za zadanie zastąpić złe wykorzystywanie atrybutu NET. Służy ona do tworzenia unikalnych identyfikatorów akcji, w całej przestrzeni konnekta, przez naszą wtyczkę.

Do tej pory wiele osób używało w tym celu wartości NET lecz służy on do innych celów i nie gwarantuje unikalności identyfikatorów.

Wartości ID używamy w następujący sposób: ID * 1000 + wartość. Gdzie wartość to kolejna liczba zaczynając od zera a zwiększana dla kolejnego identyfikatora.

W obecnej chwili należy uważać by wartość ID nie pokrywała się z jakąkolwiek wartością NET innych wtyczek.

Wartość NET

Należy podać w odpowiedzi na komunikat IM_PLUG_NET

Jest to tak zwany identyfikator sieci. Poprzez sieć należy rozumieć grupę wtyczek, które mają podobny cel i chcą się między sobą komunikować. Przykładowo jeden protokół może być obsługiwany przez kilka różnych wtyczek o tej samej wartości NET.

Wartości tej używa się przede wszystkim podczas komunikacji pomiędzy wtyczkami za pomocą funkcji IMessage. W ten sposób możemy wysyłać wiadomości do wszystkich wtyczek zainteresowanych współpracą z pewną częścią systemu.

Ogólny podział puli wartości net przedstawia poniższa tabelka.

Wartość NET Opis
< 0; 128 > Wartości dla wtyczek obsługujących protokoły sieciowe
( 128; 256 > Zarezerwowane
( 256; 8000 > Wartości przeznaczone do powszechnego użytku

Aktualną listę zarezerwowanych wartości NET znajdziesz tutaj. Poniżej znajdziesz tabelkę z podstawowymi wartościami

Identyfikator Wartość Opis
NET_AIM 60 Wtyczki obsługujące protokół AIM
NET_BROADCAST -1 Wiadomość dotrze do wtyczek wszystkich sieci
NET_EMAIL 13 Wtyczki obsługujące e-maile
NET_EXPIMP 17 Imoprt/export konfiguracji
NET_FIRST -2 Wiadomość dotrze do pierwszej wtyczki (dowolnej sieci), która potrafi ją obsłużyć.
NET_GG 10 Wtyczki obsługujące protokół GG
NET_ICQ 11 Wtyczki obsługujące protokół ICQ
NET_INTERNAL 2
NET_JABBER 12 Wtyczki obsługujące protokół JABBER
NET_KEASY 227
NET_KLAN 15 Wtyczki obsługujące protokół kLAN
NET_KONNFERENCJA 20 Wtyczki obsługujące konferencje
NET_KSTYLE 16 Wtyczki współpracujące z kStyle
NET_KTRANSFER 130 Wtyczki współpracujące z kTransfer
NET_MSN 62 Wtyczki obsługujące protokół MSN
NET_NET 1 Wtyczki obsługujące protokół "własny"
NET_NONE 0 Wiadomości do rdzenia
NET_OTHER 6 Wtyczki nie posiadające akcji, nie obsługujące wiadomości itp
NET_SMS 14 Wtyczki obsługujące SMSy
NET_SOUND 3 Wtyczki obsługujące dźwięk
NET_TLEN 63 Wtyczki obsługujące protokół TLEN
NET_UPDATE 4 Update
NET_WAPILOT 756
NET_YAHOO 61 Wtyczki obsługujące protokół YAHOO

Jak dobrać swoją własną wartość net przeczytasz tutaj.

Wartość SIG

Należy podać w odpowiedzi na komunikat IM_PLUG_SIG

Jest to skrócona nazwa/ sygnatura wtyczki. Musi jednoznacznie identyfikować wtyczkę oraz spełniać z góry ustalone zasady.

Jak dobrać poprawną sygnaturę dowiesz się tutaj.

Wartość TYPE

Należy podać w odpowiedzi na komunikat IM_PLUG_TYPE

Ogólnie mówiąc określa typ wtyczki. Za to typ informuje rdzeń, jakiego typu komunikaty nasza wtyczka chce otrzymywać. Po co rdzeń miałby wysyłać do nas komunikaty, które były by nam zbędne? Predefiniowane typy komunikatów znajdziesz w tabelce. Aby obsługiwać kilka typów komunikatów wystarczy je połączyć ze sobą operatorem logicznym lub - '|'.

Identyfikator Opis
IMT_ALL Wszystkie typy
IMT_ALLMESSAGES Otrzyma w IM_MSG_RCV wszystkie wiadomości , niezależnie od NET
IMT_CONFIG Konfiguracja
IMT_CONTACT Kontakty
IMT_CORE Wiadomość bezpośrednio do rdzenia (lub UI).
IMT_MESSAGE Wiadomości tekstowe
IMT_MESSAGEACK Będzie otrzymywać IM_MSG_ACK
IMT_MSGUI Wtyczka wykorzystuje system obsługi wiadomości tekstowych zawarty w UI
IMT_NET Wtyczka obsługuje kontakty całej swojej sieci
IMT_NETSEARCH Wtyczka obsługuje wyszukiwanie kontaktów w swojej sieci
IMT_NETUID Kontakty w sieci posiadają UID
IMT_PROTOCOL Protokół sieciowy
IMT_UI Interfejs Użytkownika

Wartość VERSION

Należy podać w odpowiedzi na komunikat IM_PLUG_VERSION

Określa wersję wtyczki

Wartość NAME

Należy podać w odpowiedzi na komunikat IM_PLUG_NAME

Określa pełną nazwę wtyczki

Wartość NETNAME

Należy podać w odpowiedzi na komunikat IM_PLUG_NETNAME

Zwraca nazwę sieci obsługiwanej przez wtyczkę. Nazwa ta wyświetlana jest w oknach dialogowych. Jeśli nie obsługujemy żadnej sieci należy podać 0 (zero).

Wartość SDKVERSION

Należy podać w odpowiedzi na komunikat IM_PLUG_SDKVERSION

Określa wersję sdk jakiej używa wtyczka. Powinna być zwrócona zawsze wartość KONNEKT_SDK_V.


Twórcą projektu kAPI, serwisu oraz materiałów w nim zawartych jest KoSiarz. Kopiowanie zabronione.