Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:co_getmessages_pu

co_GetMessages_Pu

Gibt die (erhaltenen) Nachrichten eines Community-Mitglieds aus.

Ausgegebene Nachrichten werden danach, falls dies noch nicht geschehen ist, als gelesen markiert, das bedeutet, der Status einer ungelesenen Nachricht wird um 100 erhöht. Hier die Bedeutung(en) des Status :

  • 0 bis 99 : neu (ungelesen) (z.B könnte „1“ bedeuten, „Schicke es auch als SMS“)
  • 100 bis 199 : alt (gelesen)
  • 200 bis 254 : <undefiniert>
  • 255 : gelöscht

Aus Performance-Gründen wurde der Parameter „GetNewMessages“ eingeführt und die „Blättern“-Funktionalität (mit „MessageNo“ und „MaxNumberOfMessages“) auf den Fall beschränkt, daß man sich ALLE Nachrichten („GetNewMessages = 0“) anzeigen lassen möchte.

Anmerkung zum Parameter „DateAndTimeFormat“ :

Die Möglichkeiten für diesen Parameter sind exakt die, die der ASE in der Funktion „convert“ für Datums-Formatierungen bietet (in Klammern ist das Format angegeben, um in der Jahreszahl das Jahrhundert angezeigt zu bekommen) :

  • (0 or 100) : mon dd yyyy hh:mm AM (or PM)

1 (101) : mm/dd/yy
2 : yy.mm.dd
3 (103) : dd/mm/yy
4 (104) : dd.mm.yy
5 (105) : dd-mm-yy
6 (106) : dd mon yy
7 (107) : mon dd, yy
8 (108) : hh:mm:ss

  • (9 or 109) : mon dd yyyy hh:mm:sss AM (or PM)

10 (110) : mm-dd-yy
11 (111) : yy/mm/dd
12 (112) : yymmdd

Anmerkung zur „MessageNo“ :

Gibt an, um die wievielte Nachricht es sich für das (durch „PersonIdentificationValues“ identifizierte) Mitglied handelt. Allerdings werden negative Werte zurückgegeben ! Hintergrund : Der ASE (in der Version 11.0.3) erlaubt nur aufsteigende Indizes. Da man aber im Regelfall immer die aktuellsten Messages ZUERST sehen möchte, enthält die „MessageNo“ negative integer-Werte, um zur Sortierung einen Index nutzen zu können.

Anmerkung zur Rückgabespalte „FromCommunityMember_Nickname“ :

Eine evtl. konfigurierte Zugriffsbeschränkung für das „Nickname“-Merkmal (s. pm_GetPChAccRestrForUsers_Ad) wird bewußt NICHT beachtet (da das ja DIE öffentlich sichtbare Eigenschaft in einer Community schlechthin ist) !

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategoriecommunities
Engine-TypDaten-Ermittlung
Letzte Aktualisierung6.5.4 (2013-04-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
UniqueID Eindeutige ID eines Besuchers, die dem zu identifizierenden Mitglied aktuell zugeordnet ist. Falls die Identifizierungsdaten zur Person in „SessionManagement“ (zu dieser „UniqueID“) gespeichert sind, darf „PersonIdentificationValues“ auch „NULL“ sein.
varchar(50)3.5.0
PersonIdentificationValues Liste von Werten, die das Mitglied identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in „PersonTypeSettings“ zur „PersonTypeID“ der „CommunityID“ zum Schlüssel „PersonIdentificationIDs“ hinterlegt sind.
varchar(255)3.5.0
CommunityID ID einer Community
smallint3.5.0
GetNewMessages1 „0“ : Alte (sprich „gelesene“) Nachrichten (mit „MessageStatus >= 100“) anzeigen
„1“ : Nur neue (sprich „ungelesene“) Nachrichten (mit „MessageStatus < 100“) anzeigen
bit3.5.2
DateAndTimeFormatNULL Gibt an, wie „MessageDateAndTime“ in der Rückgabemenge formatiert sein soll. „NULL“ bedeutet, daß das Format „07.02.2000 17:30:21“ gewählt wird. Ansonsten wird der Parameter für die „style“-Option der ASE-Funktion „convert“ verwendet (siehe Beschreibung).
tinyint3.5.0
MessageNoNULL Wird NUR im Fall „GetNewMessages = 0“ beachtet ! Gibt an, ab welcher Nachricht die Ausgabe beginnen soll. Mit diesem Parameter sowie „MaxNumberOfRows“ kann man sich durch die Nachrichten „blättern“.
integer3.5.0
MaxNumberOfRows20 Wird NUR im Fall „GetNewMessages = 0“ beachtet ! Gibt an, wieviele Nachrichten maximal zurückgegeben werden sollen. Mit diesem Parameter sowie „MessageNo“ kann man sich durch die Nachrichten „blättern“. („0“ und „NULL“ sind nicht erlaubt !)
tinyint3.5.0
SeparatorInIdentVals'¶' Gibt an, durch welche Zeichenkette die Werte in „PersonIdentificationValues“ getrennt sind
varchar(4)5.5.0

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
MessageNoNummer der Nachricht „Message“. Gibt an, um die wievielte Nachricht es sich für das (durch „PersonIdentificationValues“ identifizierte) Mitglied handelt. ACHTUNG : es werden negative Werte zurückgegeben !
integer3.5.0
FromCommunityMemberIDID des Community-Mitglieds, von dem die Nachricht „Message“ stammt
integer3.5.0
FromCommunityMember_NicknameEigenschaft des Mitglieds „FromCommunityMemberID“ zu dem Merkmal, anhand dessen die Communitymitglieder sich untereinander unterscheiden bzw. erkennen können. (Eintrag in „CommunitySettings“ zum Schlüssel „IdentifyingCharacteristicID“)
varchar(100)3.5.0
MessageStatusStatus der Nachricht „Message“. Bedeutung(en) :
* 0 bis 99 : neu (ungelesen) (z.B könnte „1“ bedeuten, „Schicke es auch als SMS“)
* 100 bis 199 : alt (gelesen)
* 200 bis 254 : <undefiniert>
* 255 : gelöscht
tinyint3.5.0
MessageDateAndTimeWann wurde die Nachricht „Message“ geschickt. Falls „DateAndTimeFormat = NULL“ übergeben wurde, ist das Format „07.02.2000 17:30:21“. Ansonsten wird „DateAndTimeFormat“ für die „style“-Option der ASE-Funktion „convert“ verwendet (siehe Beschreibung).
datetime3.5.0
MessageDie Nachricht von „FromCommunityMemberID“ an das (durch „PersonIdentificationValues“ identifizierte) Community-Mitglied
varchar(255)3.5.0

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-781Fehlender oder falscher Eintrag in CommunitySettingsnur indirekt
-780Fehlender oder falscher Eintrag in CommunityMemberSettingsnur indirekt
-774Login vorübergehend gesperrtnur indirekt
-773Login gesperrtnur indirekt
-772User ist nicht angemeldetnur indirekt
-771Der Sweeper ist nicht gestartetnur indirekt
-770Login zur Zeit nicht möglichnur indirekt
-660Identifikation fehlgeschlagennur indirekt
-621Fehlender oder falscher Eintrag in PersonTypeSettingsnur indirekt
-602Zur defaultUniqueID („VisitorID = -2“) können keinerlei Daten gespeichert oder verändert werdennur indirekt
-599Lizenz ist ungültig oder abgelaufennur indirekt
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-550Fehlender oder falscher Eintrag in Settingsnur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur indirekt
-500Falsche Parameterdirekt und indirekt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

6.5.4 2013-04-291. Hinweis in der Doku, daß bewusst NICHT eine evtl. konfigurierte Zugriffsbeschränkung für das „Nickname“-Merkmal beachtet wird (da ja DIE öffentlich sichtbare Eigenschaft)
2. Datentyp-Erweiterung von „SeparatorInIdentVals“ [von „1“ auf „4“]
5.5.0 2008-01-071. Neuer Parameter „SeparatorInIdentVals“
2. Ausgabe via „print“ im Fehler-Fall „-500“, die nähere Informationen über die Ursache enthält
3. Bearbeitung des Quellcodes hinsichtlich neuer Konventionen
4.0.2 2003-06-11In einem Fall wurde GAR KEIN Ergebnis anstelle einer leeren Ergebnismenge zurückgegeben !
3.5.2 2001-01-28
3.5.0 2000-11-23Erstmalig in dieser Version erstellt

Code-Snippets

Engine Playground

Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/co_GetMessages_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<value>'

Mit xmllint 6) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/co_GetMessages_Pu?UniqueID=<value>&PersonIdentificationValues=<value>&CommunityID=<value>' | xmllint --format -
dStore_php
use dStore_php\WebService;
 
$service = new WebService\Service( WebService\Scheme::HTTP,'<partner>-<project>.dstore.de', 80);
 
$request = new WebService\Requests\Engine\Procedure\Request(
			new WebService\Requests\AccessData('default'),
	'co_GetMessages_Pu',
		array(
			'UniqueID' => '<value>',
			'PersonIdentificationValues' => '<value>',
			'CommunityID' => <value>,
			// 'GetNewMessages' => 1,
			// 'DateAndTimeFormat' => NULL,
			// 'MessageNo' => NULL,
			// 'MaxNumberOfRows' => 20,
			// 'SeparatorInIdentVals' => '¶'
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
engine/execute

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'
<?xml version="1.0" encoding="UTF-8"?>
<ListOfBatches>
	<Batch No="0">
		<Procedure Name="co_GetMessages_Pu">
			<Parameters>
				<Parameter Name="UniqueID"><!-- varchar value --></Parameter>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<Parameter Name="CommunityID"><!-- smallint value --></Parameter>
				<!-- <Parameter Name="GetNewMessages">1</Parameter> -->
				<!-- <Parameter Name="DateAndTimeFormat">NULL</Parameter> -->
				<!-- <Parameter Name="MessageNo">NULL</Parameter> -->
				<!-- <Parameter Name="MaxNumberOfRows">20</Parameter> -->
				<!-- <Parameter Name="SeparatorInIdentVals">'¶'</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/co_getmessages_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)