Type Alias SdkQuestionEntityPublicProps

Type Declaration

• { card?: never; query?: never; questionId: SdkQuestionId | null; token?: never }

  • Optionalcard?: never

  • Optionalquery?: never

  • questionId: SdkQuestionId | null

    The ID of the question.
    This is either:
    

    • the numerical ID when accessing a question link, i.e. http://localhost:3000/question/1-my-question where the ID is 1
      
    • the string ID found in the entity_id key of the question object when using the API directly or using the SDK Collection Browser to return data
      
    • new to show the notebook editor for creating new questions
      
    • new-native to show the SQL editor for creating new native questions

  • Optionaltoken?: never

• {
      card?: never;
      query?: never;
      questionId?: never;
      token: SdkEntityToken | null;
  }

  • Optionalcard?: never

  • Optionalquery?: never

  • OptionalquestionId?: never

  • token: SdkEntityToken | null

    A valid JWT token for the guest embed.

• {
      card: string | MetabaseCard;
      query?: never;
      questionId?: never;
      token?: never;
  }

  • card: string | MetabaseCard

    An ad-hoc question to render without saving it first. Either a MetabaseCard object, or a serialized card string copied from a question URL hash (/question#<base64> or the bare base64).

  • Optionalquery?: never

  • OptionalquestionId?: never

  • Optionaltoken?: never

• {
      card?: never;
      query: MetabaseQueryObject | null;
      questionId?: never;
      token?: never;
  }

  • Optionalcard?: never

  • query: MetabaseQueryObject | null

    A table-backed ad hoc query created with useMetabaseQueryObject.

  • OptionalquestionId?: never

  • Optionaltoken?: never