Apex 開発者ガイド
jNewer Version Available
excludeContextTypes()
署名
public Set<Canvas.ContextTypeEnum> excludeContextTypes()
戻り値
型: SET<Canvas.ContextTypeEnum>
このメソッドでは、null または 0 個以上の ContextTypeEnum 値が返されます。デフォルトでは、null が返されると、すべての属性が有効になります。設定できる ContextTypeEnum 値は、次のとおりです。
- Canvas.ContextTypeEnum.ORGANIZATION
- Canvas.ContextTypeEnum.RECORD_DETAIL
- Canvas.ContextTypeEnum.USER
使用方法
このメソッドを実装して、キャンバスアプリケーションのコンテキストで無効にする属性を指定します。disabled 属性により、関連するキャンバスコンテキスト情報が null に設定されます。
属性を無効にすると、署名付き要求およびキャンバスコンテキストのサイズが減少するため、パフォーマンスを高められます。また、Salesforce で disabled 属性を取得する必要がなくなり、パフォーマンスが大幅に向上します。
CanvasRequest で提供される Context オブジェクトのコンテキスト情報についての詳細は、『Force.com Canvas 開発者ガイド』を参照してください。
例
この実装例では、キャンバスコンテキストで組織情報が無効になるように指定します。
1public Set<Canvas.ContextTypeEnum> excludeContextTypes() {
2 Set<Canvas.ContextTypeEnum> excluded = new Set<Canvas.ContextTypeEnum>();
3 excluded.add(Canvas.ContextTypeEnum.ORGANIZATION);
4 return excluded;
5}