Zeigen

From VZ Developer Wiki

Jump to: navigation, search

Das ist die Dokumentation für die externe 'Zeigen' Funktion auf den Plattformen der VZ-Netzwerke. Damit haben die Nutzer die Möglichkeit, Links direkt in den Buschfunk zu posten oder ihren Freunden mit Hilfe des privaten Nachrichten Dienstes von VZ zu schicken.


Contents

OExchange kompatible endpoints

Mit OExchange ist es möglich, jede URL und jeden Webinhalt zu teilen.

Was ist OExchange?

  • Eine Möglichkeit für Dienste, Inhalte zu empfangen und alle Service spezifischen Integrationsvoraussetzungen zu entfernen.
  • Ein Tool auch für eine zukünftige Weiterentwicklung, mit dem sich Dienste und endpoints selbst veröffentlichen können, um die Integration von Diensten zu ermöglichen, die es zum Entwicklungszeitpunkt noch nicht gab
  • Ein dezentralisiertes, userzentriertes Modell um bevorzugste Dienste zu speichern und um Zeigen noch persönlicher zu gestalten.


Detailiertere Informationen und eine Testumgebung gibt es unter http://www.oexchange.org/.

endpoints

Wenn endpoints direkt in den Code geschrieben werden sollen und man auf die Nutzung von OExchange verzichtet, sollte unser PlatformRedirector genutzt werden, der den User innerhalb des aktuellen Browsers automatisch zur richtigen Plattform weiterleitet. (Dieses Ziel ist im OExchange XRD ebenfalls erwähnt):

Natürlich können Ziele auch direkt über die VZ-Platform gesetzt werden:

Unterstützte Paramter

Alle Parameter müssen über die URL encoded werden.


url (erforderlich)
Die URL des angebotenen Contents. Diese URL sollte etwas sein, dass der User direkt über den Browser aufrufen kann. Die URL muss urlencoded sein.
title (optional)
Ein menschenleserlicher Titel für den Content. Das ist ein typisches Äquivalent zum Seitentitel Meta Tag und transportiert die gleiche Art der Information. Der Titel wird ebenfalls der Standard-Betreff der zu versendenden Nachricht sein.
description (optional)
Ein menschenleserlicher Titel für den Content. Das ist ein typisches Äquivalent zum Seitenbeschreibung-Meta Tag und transportiert die gleiche Art der Information.
provider (optional)
Optionaler Name des Providers, der die Seite bereit stellt (site)
thumbnail (optional)
Optionale URL die zu einem Thumbnail für den Content führt
noembed (optional)
Wenn gesetzt wird die Quelle mit ihrerOEmbed Nennung unterdrückt
message (optional)
Optionale Standard-Nachricht für den Buchschfunk oder den Inhalt der persönlichen Nachrichten
type (optional)
Gültige Werte ('message' or 'feed'), wenn gesetzt kann der User nicht mehr wählen, ob er die Zeigen Funktion über den Buschfunk oder private Nachrichten nutzen möchte.

OpenGraph Support

Als Alternative zur Übergabe von Meta-Daten als Abfrage-Paramter unterstützen wir evenfalls den Empfang von Meta-Daten mittels des OpenGraph Protokolls. Du musst einfach ein paar zusätzliche Meta Tags in den head der Seite setzen, die gezeigt werden soll:

<meta property="og:title" content="title" />
<meta property="og:description" content="description" />
<meta property="og:site_name" content="your site name" />
<meta property="og:image" content="http://example.com/thumbnail.jpg" />

Mehr Informationen über das OpenGraph Protokoll gibt es unter http://opengraphprotocol.org/

Discovery

Die Host Meta Datei (see http://tools.ietf.org/html/draft-hammer-hostmeta-12 for details) liegt unter:

Die Host Meta Datei beinhaltet einen Link mit dem relation type "http://www.oexchange.org/spec/0.8/rel/offer" der zu einer OExchange XRD Datei führt, die den Zeigen endpoint und Meta Informationen wie beispielsweise Icons, Netzwerknamen oder Beschreibungen enthält.

Du kannst den VZ discovery flow hier testen: http://www.oexchange.org/tools/discoveryharness/

Aussehen

Du solltest entweder die Icons nutzen, die die OExchange XRD Datei enthält oder die folgenden:

  • Vz-zeigen1.png
  • Vz-zeigen2.png
  • Vz-zeigen3.png
  • Share 16x16.png
  • Share 18x18.png
  • Share 32x32.png

Beispiel ohne discovery

http://platform-redirect.vz-modules.net/r/Link/Share/?url=http%3A%2F%2Fwww.example.com&description=descripton&title=title

http://www.studivz.net/Link/Share/?url=http%3A%2F%2Fwww.example.com&description=descripton&title=title

Bibliothek

Die VZ JS-Library beinhaltet ebenfalls einen einfachen Weg, um die Zeigen Funktion auf deiner Seite einzubauen.

Personal tools