コンストラクタ・ファンクション・パラメータの構成
サイトでコンストラクタ関数の新しいインスタンスを作成する場合、そのインスタンスは、コンテンツ・レイアウトの開発に役立つcontentItemData
、scsData
およびcontentClient
を含むパラメータを渡します。
コンストラクタ関数のコード例を次に示します:
function ContentLayout(params) {
this.contentItemData = params.contentItemData || {};
this.scsData = params.scsData;
this.contentClient = params.contentClient;
}
ContentLayout.prototype = {
render: function (parentObj) {
var content = {
blogTitle: this.contentItemData.data['starter-blog-post_title'],
};
if (this.scsData) {
content = $.extend(content, {
'scsData': this.scsData
});
}
}
};
return ContentLayout;
コンストラクタ関数パラメータには、次のオブジェクトが含まれます:
-
params.contentItemData: 名前、説明、IDおよびデータを含むコンテンツ・アイテムが含まれます。 たとえば、コンテンツ・アイテムのフィールド
blogpost_title
には、params.contentItemData.data['blogpost_title']
を使用してアクセスできます。 -
params.scsData:: このオブジェクトは、サイト内からコンストラクタがコールされるときに情報を渡します。 このオブジェクトは、サードパーティ・アプリケーションでレンダリングされたコンテンツ・レイアウトには存在しません。 このオブジェクトには、Sites SDKオブジェクト、トリガーを生成するメソッド
contentTriggerFunction
および「詳細」ページ・リンクが含まれます。 -
params.contentClient: これは、Content SDKから作成され、コンテンツ・レイアウトを呼び出すために使用される
contentClient
オブジェクトです。 したがって、これは、コンテンツ・サーバーに適したパラメータを使用して構成されます。 コンテンツ・サーバーへの追加呼び出しが必要な場合は、独自のものを作成するのではなく、このcontentClient
オブジェクトを使用できます。 このオブジェクトには、コンテンツ用のクライアントAPIが含まれます。 APIを使用すると、コンテンツ・アイテムとそのコンテンツ・タイプを問合せ、検索および取得できます。 他のヘルパーAPIも利用できます。たとえば、expandMacros()
を使用して、リッチ・テキストで使用されるマクロを展開します。