ICIRESTInvocationEventRuleParams Interface

Used to view or specify REST Invocation Event Rules parameters.

Members

  • Property Endpoint As String

  • Set or retrieves the end point for the event rule.

    HRESULT Endpoint([out, retval] BSTR *pVal);
    HRESULT Endpoint([in] BSTR newVal);

    EFTv8.0.5 and later

  • Function GetAuthParams() As CIRESTInvocationAuthParams

  • Retrieve authentication parameters (`ICIRESTInvocationAuthParams`).

    HRESULT GetAuthParams([out, retval] ICIRESTInvocationAuthParams** ppVal);

    Example (VBScript), eetrieving:

    Set Rules = site.EventRules(ET_REST_INVOCATION)
    Set rule = Rules.Item(0)
    Set ruleParams = rule.GetParams
    Set authParams = ruleParams.GetAuthParams

    EFTv8.0.5 and later

  • Function GetVerifyParams() As CIRESTInvocationVerifyParams

  • Retrieve verification parameters.

    HRESULT GetVerifyParams([out, retval] ICIRESTInvocationVerifyParams** ppVal);

    Example (VBScript) Retrieving:

    Set Rules = site.EventRules(ET_REST_INVOCATION)
    Set rule = Rules.Item(0)
    Set ruleParams = rule.GetParams
    Set verifyParams = ruleParams.GetVerifyParams

    EFTv8.0.5 and later

  • Property MinimalNumberOfParamsInQuery As Int

  • Sets or retrieves the minimal incoming number of query parameters for the even rule.

    HRESULT MinimalNumberOfParamsInQuery([out, retval] int *pVal);
    HRESULT MinimalNumberOfParamsInQuery([in] int newVal);

    EFTv8.0.5 and later

  • Property Name As String

  • Sets or retrieves the name for the event rule.

    EFT v8.0.5 and later

  • Sub SetAuthParams(pVal As CIRESTInvocationAuthParams)

  • HRESULT SetAuthParams([in] ICIRESTInvocationAuthParams* pVal);

    Example:

    ruleParams.SetAuthParams(authParams)

    EFTv8.0.5 and later

  • Sub SetVerifyParams(pVal As CIRESTInvocationVerifyParams)

  • Sets the verification parameters.

    HRESULT SetVerifyParams([in] ICIRESTInvocationVerifyParams* pVal);

    Example (VBScript) Specifying:

    ruleParams.SetVerifyParams(verifyParams)

    EFTv8.0.5 and later