この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Newer Version Available

This content describes an older version of this product. View Latest

DescribeQuickActionResult クラス

クイックアクションの Describe メタデータ情報���含まれます。

名前空間

QuickAction

使用方法

QuickAction describeQuickActions メソッドは、クイックアクションの Describe Result オブジェクト (QuickAction.DescribeQuickActionResult) の配列を返します。

DescribeQuickActionResult のプロパティ

DescribeQuickActionResult のプロパティは次のとおりです。

canvasapplicationname

カスタムアクションによって呼び出された Canvas アプリケーションの名前。

署名

public String canvasapplicationname {get; set;}

プロパティ値

型: String

colors

色情報の配列。各色はテーマに関連付けられています。

署名

public List<Schema.DescribeColorResult> colors {get; set;}

プロパティ値

型: List<Schema.DescribeColorResult>

contextsobjecttype

アクションに使用するオブジェクト。API バージョン 29.0 以前では getsourceSobjectType() でした。

署名

public String contextsobjecttype {get; set;}

プロパティ値

型: String

defaultvalues

アクションのデフォルト値。

署名

public List<QuickAction.DescribeQuickActionDefaultValue> defaultvalues {get; set;}

flowdevname

カスタムアクションがフローを呼び出す場合、そのフローの完全修飾名。

署名

public String flowdevname {get; set;}

プロパティ値

型: String

flowrecordidvar

カスタムアクションがフローを呼び出す場合、そのカスタムアクションがレコード の ID を渡す先の入力変数。

署名

public String flowrecordidvar {get; set;}

プロパティ値

型: String

有効な値は、null または recordId です。

height

アクションペインの高さ (ピクセル単位)。

署名

public Integer height {get; set;}

プロパティ値

型: Integer

iconname

アクションに使用するアイコンの名前。カスタムアイコンが使用されていない場合、この値は設定されません。

署名

public String iconname {get; set;}

プロパティ値

型: String

icons

アイコンの配列。各アイコンはテーマに関連付けられています。

署名

public List<Schema.DescribeIconResult> icons {get; set;}

プロパティ値

型: List<Schema.DescribeIconResult>

クイックアクションに関連付けられたカスタムアイコンがなく、クイックアクションによって特定のオブジェクトが作成される場合、アイコンは作成されるオブジェクトに使用されるアイコンに対応します。たとえば、クイックアクションによって取引先が作成される場合、アイコン配列には取引先に使用されるアイコンが含まれます。

カスタムアイコンがクイックアクションに関連付けられていた場合、配列にはそのカスタムアイコンが含まれます。

iconurl

アクションに使用するアイコンの URL。このアイコン URL は、Spring '10 で導入された現在の Salesforce テーマに使用される 32×32 アイコン、またはカスタムアイコン (存在する場合) に対応します。

署名

public String iconurl {get; set;}

プロパティ値

型: String

layout

アクションが存在するレイアウトのセクション。

署名

public QuickAction.DescribeLayoutSection layout {get; set;}

プロパティ値

型: QuickAction.DescribeLayoutSection

lightningcomponentbundleid

カスタムアクションが Lightning コンポーネントを呼び出す場合、そのコンポーネントが属する Lightning コンポーネントバンドルの ID。

署名

public String lightningcomponentbundleid {get; set;}

プロパティ値

型: String

lightningcomponentbundlename

カスタムアクションが Lightning コンポーネントを呼び出す場合、そのコンポーネントが属する Lightning コンポーネントバンドルの名前。

署名

public String lightningcomponentbundlename {get; set;}

プロパティ値

型: String

lightningcomponentqualifiedname

カスタムアクションが呼び出す Lightning コンポーネントの完全修飾名。

署名

public String lightningcomponentqualifiedname {get; set;}

プロパティ値

型: String

miniiconurl

アイコンの URL。このアイコン URL は、Spring '10 で導入された現在の Salesforce テーマに使用される 16×16 アイコン、またはカスタムアイコン (存在する場合) に対応します。

署名

public String miniiconurl {get; set;}

プロパティ値

型: String

showquickactionlcheader

Lightning コンポーネントのクイックアクションヘッダーとフッターが表示されるかどうかを示します。false の場合は、クイックアクションのタイトルが含まれるヘッダーと、[保存] および [キャンセル] ボタンが含まれるフッターの両方が非表示になります。

署名

public Boolean showquickactionlcheader {get; set;}

プロパティ値

型: Boolean

showquickactionvfheader

Visualforce クイックアクションヘッダーとフッターが表示されるかどうかを示します。false の場合は、クイックアクションのタイトルが含まれるヘッダーと、[保存] および [キャンセル] ボタンが含まれるフッターの両方が非表示になります。

署名

public Boolean showquickactionvfheader {get; set;}

プロパティ値

型: Boolean

targetparentfield

アクションの親オブジェクト種別。対象オブジェクトを親オブジェクトにリンクします。たとえば、対象オブジェクトが取引先責任者であり、親オブジェクトが取引先である場合、この値は取引先になります。

署名

public String targetparentfield {get; set;}

プロパティ値

型: String

targetrecordtypeid

対象レコードのレコードタイプ。

署名

public String targetrecordtypeid {get; set;}

プロパティ値

型: String

targetsobjecttype

アクションの対象オブジェクト種別。

署名

public String targetsobjecttype {get; set;}

プロパティ値

型: String

visualforcepagename

カスタムアクションに関連付けられた Visualforce ページの名前。

署名

public String visualforcepagename {get; set;}

プロパティ値

型: String

visualforcepageurl

アクションに関連付けられた Visualforce ページの URL。

署名

public String visualforcepageurl {get; set;}

プロパティ値

型: String

width

Visualforce ページ、キャンバスアプリケーション、または Lightning コンポーネントをコールするカスタムアクションのアクションペインの幅 (ピクセル単位)。

署名

public Integer width {get; set;}

プロパティ値

型: Integer

DescribeQuickActionResult のメソッド

DescribeQuickActionResult のメソッドは次のとおりです。すべてインスタンスメソッドです。

getActionEnumOrId()

アクションの一意の ID を返します。アクションに ID がない場合、API 名が使用されます。

署名

public String getActionEnumOrId()

戻り値

型: String

getCanvasApplicationName()

キャンバスアプリケーションの名前を返します (使用されている場合)。

構文

public String getCanvasApplicationName()

戻り値

型: String

getColors()

色情報の配列を返します。各色はテーマに関連付けられています。

署名

public List<Schema.DescribeColorResult> getColors()

getContextSobjectType()

アクションに使用するオブジェクトを返します。API バージョン 30.0 以降では getsourceSobjectType() に置き換わります。

署名

public String getContextSobjectType()

戻り値

型: String

getDefaultValues()

アクションのデフォルト値を返します。

署名

public List<QuickAction.DescribeQuickActionDefaultValue> getDefaultValues()

getFlowDevName()

カスタムアクションがフローを呼び出す場合、そのカスタムアクションが呼び出すフローの完全修飾名を返します。

署名

public String getFlowDevName()

戻り値

型: String

getFlowRecordIdVar()

カスタムアクションがフローを呼び出す場合、そのカスタムアクションがレコード の ID を渡す先の入力変数を返します。

署名

public String getFlowRecordIdVar()

戻り値

型: String

getHeight()

アクションペインの高さ (ピクセル単位) を返します。

署名

public Integer getHeight()

戻り値

型: Integer

getIconName()

アクションのアイコン名を返します。

署名

public String getIconName()

戻り値

型: String

getIconUrl()

アクションに使用する 32 x 32 アイコンの URL を返します。

署名

public String getIconUrl()

戻り値

型: String

getIcons()

タブに使用する色を示す Schema.DescribeIconResult オブジェクトのリストを返します。

署名

public List<Schema.DescribeIconResult> getIcons()

getLabel()

アクションの表示ラベルを返します。

署名

public String getLabel()

戻り値

型: String

getLayout()

アクションを構成するレイアウトセクションを返します。

署名

public QuickAction.DescribeLayoutSection getLayout()

getLightningComponentBundleId()

カスタムアクションが Lightning コンポーネントを呼び出す場合、そのコンポーネントが属する Lightning コンポーネントバンドルの ID を返します。

署名

public String getLightningComponentBundleId()

戻り値

型: String

getLightningComponentBundleName()

カスタムアクションが Lightning コンポーネントを呼び出す場合、そのコンポーネントが属する Lightning コンポーネントバンドルの名前を返します。

署名

public String getLightningComponentBundleName()

戻り値

型: String

getLightningComponentQualifiedName()

カスタムアクションが Lightning コンポーネントを呼び出す場合、そのカスタムアクションが呼び出す Lightning コンポーネントの完全修飾名を返します。

署名

public String getLightningComponentQualifiedName()

戻り値

型: String

getMiniIconUrl()

16 x 16 アイコンの URL を返します。

署名

public String getMiniIconUrl()

戻り値

型: String

getName()

アクション名を返します。

署名

public String getName()

戻り値

型: String

getShowQuickActionLcHeader()

Lightning コンポーネントのクイックアクションヘッダーとフッターが表示されるかどうかを返します。

署名

public Boolean getShowQuickActionLcHeader()

戻り値

型: Boolean

false の場合は、クイックアクションのタイトルが含まれるヘッダーと、[保存] および [キャンセル] ボタンが含まれるフッターの両方が非表示になります。

getShowQuickActionVfHeader()

Visualforce のクイックアクションヘッダーとフッターが表示されるかどうかを返します。

署名

public Boolean getShowQuickActionVfHeader()

戻り値

型: Boolean

false の場合は、クイックアクションのタイトルが含まれるヘッダーと、[保存] および [キャンセル] ボタンが含まれるフッターの両方が非表示になります。

getSourceSobjectType()

アクションに使用するオブジェクト種別を返します。

署名

public String getSourceSobjectType()

戻り値

型: String

getTargetParentField()

アクションの親オブジェクトの種別を返します。

署名

public String getTargetParentField()

戻り値

型: String

getTargetRecordTypeId()

対象レコードのレコードタイプを返します。

署名

public String getTargetRecordTypeId()

戻り値

型: String

getTargetSobjectType()

アクションの対象オブジェクト種別を返します。

署名

public String getTargetSobjectType()

戻り値

型: String

getType()

作成アクションまたはカスタム Visualforce アクションを返します。

署名

public String getType()

戻り値

型: String

getVisualforcePageName()

Visualforce を使用する場合、アクションに関連付けられたページの名前を返します。

署名

public String getVisualforcePageName()

戻り値

型: String

getVisualforcePageUrl()

アクションに関連付けられた Visualforce ページの URL を返します。

署名

public String getVisualforcePageUrl()

戻り値

型: String

getWidth()

カスタムアクションを作成する場合、アクションペインの幅 (ピクセル単位) を返します。

署名

public Integer getWidth()

戻り値

型: Integer