Carrinho


getCart


Requere o conteúdo do carrinho atual.


Argumentos:

Nome Tipo Padrão Descrição
cb function undefined Função que será chamada quando a ação for concluída. Recebe 1 parametro com o resultado da requisição.


Exemplo:

// getCart(cb)
yb.utils.getCart(function(cart) {
  // Exibe todas informações do carrinho
  console.log(cart);
});



emptyCart


Limpa o conteúdo do carrinho atual.


Argumentos:

Nome Tipo Padrão Descrição
cb function undefined Função que será chamada quando a ação for concluída. Recebe 1 parametro com o resultado da requisição.


Exemplo:

// emptyCart(cb)
yb.utils.emptyCart(function(result) {
  // Exibe o resultado da operação
  console.log(result);
});



addCartProduct


Adiciona um produto (variante) no carrinho atual.


Argumentos:

Nome

Tipo

Padrão

Descrição

variantId
integer
undefined

Variate a ser adicionada no carrinho

qty

integer

1 Quantidade a ser adicionada.

cb

function

undefined

Função que será chamada quando a ação for concluída. Recebe 1 parametro com o resultado da requisição.


Exemplo:

// addCartProduct(variantId, qty, cb)
yb.utils.addCartProduct(123, 1, function(result) {
  // Exibe o resultado da operação
  console.log(result);
});



updateCartProduct


Redefine a quantidade de um item do carrinho, se 0 o produto será removido do carrinho atual.


INFO: Este método não soma ou subtrai a quantidade do produto. Para adicionar uma quantidade de produto no carrinho é necessário passar a quantidade final(calculada) para o método.


Argumentos:

Nome

Tipo

Padrão

Descrição

lineItemId
integer
undefined

ID do item do carrinho a ser modificado

qty

integer

1 Quantidade do produto no carrinho

cb

function

undefined

Função que será chamada quando a ação for concluída. Recebe 1 parametro com o resultado da requisição.


Exemplo:

// updateCartProduct(lineItemId, qty, cb)
yb.utils.updateCartProduct(123, 1, function(result) {
  // Exibe o resultado da operação
  console.log(result);
});



removeCartProduct


Remove o item do carrinho atual.


Argumentos:

Nome

Tipo

Padrão

Descrição

lineItemId

integer

undefined

ID do item do carrinho a ser removido

cb

function

undefined

Função que será chamada quando a ação for concluída. Recebe 1 parametro com o resultado da requisição.


Exemplo:

 

// removeCartProduct(lineItemId, cb)
yb.utils.removeCartProduct(123, function(result) {
  // Exibe o resultado da operação
  console.log(result);
});



Resultado das Operações


Todos os resultados consistem em uma classe chamada de UtilsResult.


Para demonstrar os métodos desta classe iremos utilizar esta requisição de carrinho como exemplo. Todos os métodos citados abaixo serão chamados dentro deste contexto.


yb.utils.getCart(function(result) {
  // `result` é um objeto da classe `UtilsResult`
  // ...
});



hasError


Verifica se a ação possui algum erro.


Retorno: true se houver algum erro ou false se não.


Exemplo:

// hasError()
result.hasError(); // Retorna `true` ou `false`



error


Em caso de erro é possível acessa-lo através desta variável de instancia.


Retorno: string ou object com o erro.


Exemplo:

console.log(result.error); // ...



anyResult


Verifica se a resposta possui algum resultado.


Retorno: true se houver resultado ou false se não.


Exemplo:

// anyResult()
result.anyResult(); // No caso do carrinho retorna `true` se o carrinho existir.



data


Acessa o resultado da operação.


Retorno: Array ou Object com os dados referentes a ação.


Exemplo:

console.log(result.data); // No caso do carrinho o carrinho em si.